application.supportsAction

Purpose:

Allow integrations to discover whether a certain action is supported by the Host application

Sample Usage:

import host from '@elliemae/em-ssf-guest'

...

const action = "ACTION_ID"

async function displayApplicationCapabilities(action) {
  try {
    const applicationObject = await host.getObject('application')
    const supportForAction = applicationObject.supportsAction(action)

    console.log(supportForAction)
  } catch (error) {
    console.log({error})
  }
}

displaySupportForAction(action)

import host from '@elliemae/em-ssf-guest'

...

const action = "ACTION_ID"

host.getObject('application')
  .then(
    (applicationObject) => {
      const supportForAction = applicationObject.supportsAction(action)

      console.log(supportForAction)
    }
  )
  .catch(
    (error) => {
      console.log({error})
    }
  )

Interface:

Input:

None

Returns:

Type: Boolean

Returns true or false, indicating whether the action is supported by the host application

Currently Supported Actions:

Details on each actions specific interface are defined in the application.performAction method reference.

Action ID	Description	Supporting Applications
`getAvailableResources`	Allow the user to select and attach files from the host applications document repository (the Encompass eFolder, for example), or upload attachments from their local drive. References to said file attachments - referred to as `resources` in the EPC API - are made available to the caller of this method once the action is fulfilled by the user.	`Desktop Version of Encompass` `Web Version of Encompass`
`updateCredentials`	Allow the user to update the credentials assigned to them for use with your application - as long as they are entitled to do so by their Administrator. The newly updated credentials are provided to the caller of this method once the action is fulfilled by the user.	`Desktop Version of Encompass` `Web Version of Encompass` `Encompass Consumer Connect`
`getRoles`	Allow the user to obtain a list of Roles from Encompass Settings exposed to Encompass Partner Connect, so that a partner can support configurations based on that data. The user calling this action needs to have the required permission configured in the Encompass Settings.	`Desktop Version of Encompass` `Web Version of Encompass`
`getPersonas`	Allow the user to obtain a list of Personas from Encompass Settings exposed to Encompass Partner Connect, so that a partner can support configurations based on that data. The user calling this action needs to have the required permission configured in the Encompass Settings.	`Desktop Version of Encompass` `Web Version of Encompass`
`getEligibleServiceSetups`	Allow the user to obtain a list of eligible service setups for the current partner products.	`Desktop Version of Encompass` `Web Version of Encompass`
`setContext`	Allow the user to set the context of the current partner UI to a specific partner product using `serviceSetupId` or `productId`.	`Desktop Version of Encompass` `Web Version of Encompass`
`getContext`	Allow the user to get the current UI context.	`Desktop Version of Encompass` `Web Version of Encompass`