Class Workflow
Workflow service integration
Methods summary
public
|
|
public
array
|
#
link( string $templateId, string $monitorableId, string $friendyName, array $customFields = [] )
Assign a local ID and settings to the given template ready for use.
Assign a local ID and settings to the given template ready for use.
Parameters
- $templateId
- the chosen template ID (uuidv4)
- $monitorableId
- an app-specific identifier to target this monitoring workflow in future
- $friendyName
- The name that will appear in Reporting and elsewhere, human readable
- $customFields
- any merge fields defined by the template.
Returns
array Service response. It is the caller's responsibility to validate and extract info
See
Comprobo\Verify\Workflow::listTemplates for how to find available templates
Comprobo\Verify\Workflow::getMergeFields for how to fetch available merge fields for a template
|
public
|
#
activate( $userId, $monitorableId )
Request the parameters to give to the JavaScript SDK in order to
begin the monitoring for your monitorable activity.
Request the parameters to give to the JavaScript SDK in order to
begin the monitoring for your monitorable activity.
Once this has been called the configuration for the linked template
identified by $monitorableId will be locked.
Parameters
- $userId
- local user ID
- $monitorableId
- local monitorable ID provided during the
link call
See
self::link
|
public
array
|
#
listTemplates( )
Fetch the list of available template types.
Fetch the list of available template types.
Returns
array The list of results from the service
|