Web Components
  1. Injectables
  2. CallbackService

File

platform-components-ng/projects/platform-components-lib/src/lib/services/callback.service.ts

Description

Callback service

Index

Properties
Methods

Constructor

constructor()

Methods

Async executeCallback
executeCallback(callbackName, data)

Triggers a callback and invokes callback handler of all subscribers which are registered for the event.

Parameters :
Name Optional Description
callbackName No
data No

to be provided to method callback.
Returns : {}

Promise
executeCallbackSync
executeCallbackSync(callbackName, data)

Triggers a callback and invokes callback handler of all subscribers which are registered for the event.

Parameters :
Name Optional Description
callbackName No
data No

to be provided to method callback.
Returns : boolean

void
registerCallback
registerCallback(callbackName, callback, scopeObj)

Register callback

Parameters :
Name Optional Description
callbackName No
callback No

function to be called when callback is invoked. Callback event data will be provided as argument to function.
scopeObj No

An object instance over which the callback function will be invoked
Returns : void

void
removeCallback
removeCallback(callbackName, callback, scopeObj)

Unregister a handler from a callback it was registered for.

Parameters :
Name Optional Description
callbackName No
callback No

function of handler to be unregistered
scopeObj No

The object instance over which the callback function was configured to execute. It must be the same scope object as provided during callback registration
Returns : void

void

Properties

Static Readonly Callbacks
Type : object
Default value : { /** * Triggers before asset/folder checkin * Param eventData - Event data containing following information * - assetInfo:CheckinEventData - user modifiable * - isFolder:boolean - readOnly * - assetId:number - readOnly * Return { assetInfo, isFolder, assetId } or false to cancel the event **/ BEFORE_SAVE_SUBMIT: "BEFORE_SAVE_SUBMIT", // Called after asset/folder checkin AFTER_SAVE_SUBMIT: "AFTER_SAVE_SUBMIT", // Called before asset details open like info/detail BEFORE_ASSET_DETAIL_ACTION: "BEFORE_ASSET_DETAIL_ACTION", // Called before asset preview action BEFORE_ASSET_PREVIEW_ACTION: "BEFORE_ASSET_PREVIEW_ACTION", // Called before asset links/refernces action BEFORE_ASSET_LINKS_ACTION: "BEFORE_ASSET_LINKS_ACTION", // Called before asset properties action BEFORE_ASSET_PROPERTIES_ACTION: "BEFORE_ASSET_PROPERTIES_ACTION", // Called before collection details BEFORE_COLLECTION_DETAIL_ACTION: "BEFORE_COLLECTION_DETAIL_ACTION", // Called before asset publish action BEFORE_PUBLISH_ASSET_ACTION: "BEFORE_PUBLISH_ASSET_ACTION", // Called before asset submit/done for publishing BEFORE_PUBLISH_ASSET_SUBMIT: "BEFORE_PUBLISH_ASSET_SUBMIT", // Called after asset published successfully AFTER_PUBLISH_ASSET_SUBMIT: "AFTER_PUBLISH_ASSET_SUBMIT", // Called before save revision action BEFORE_SAVE_REVISION_ACTION: "BEFORE_SAVE_REVISION_ACTION", // Called before save revision submit/done BEFORE_SAVE_REVISION_SUBMIT: "BEFORE_SAVE_REVISION_SUBMIT", // Called after revision saved AFTER_SAVE_REVISION_SUBMIT: "AFTER_SAVE_REVISION_SUBMIT", // Called before asset checkout/edit action BEFORE_EDIT_ASSET_ACTION: "BEFORE_EDIT_ASSET_ACTION", // Called after asset checkout/edit action AFTER_EDIT_ASSET_ACTION: "AFTER_EDIT_ASSET_ACTION", // Called before asset download action BEFORE_DOWNLOAD_ASSET_ACTION: "BEFORE_DOWNLOAD_ASSET_ACTION", // Called after asset download action AFTER_DOWNLOAD_ASSET_ACTION: "AFTER_DOWNLOAD_ASSET_ACTION", // Called before/after asset cancel checkout/discard action BEFORE_DISCARD_ASSET_ACTION: "BEFORE_DISCARD_ASSET_ACTION", AFTER_DISCARD_ASSET_ACTION: "AFTER_DISCARD_ASSET_ACTION", // Called before/after asset redindex action BEFORE_REINDEX_ASSET_ACTION: "BEFORE_REINDEX_ASSET_ACTION", AFTER_REINDEX_ASSET_ACTION: "AFTER_REINDEX_ASSET_ACTION", // Called before asset delete action BEFORE_DELETE_ASSET_ACTION: "BEFORE_DELETE_ASSET_ACTION", // Called before/after asset delete submit/done BEFORE_DELETE_ASSET_SUBMIT: "BEFORE_DELETE_ASSET_SUBMIT", AFTER_DELETE_ASSET_SUBMIT: "AFTER_DELETE_ASSET_SUBMIT", // Called before collection delete action BEFORE_DELETE_COLLECTION_ACTION: "BEFORE_DELETE_COLLECTION_ACTION", // Called before/after collection delete submit/done BEFORE_DELETE_COLLECTION_SUBMIT: "BEFORE_DELETE_COLLECTION_SUBMIT", AFTER_DELETE_COLLECTION_SUBMIT: "AFTER_DELETE_COLLECTION_SUBMIT", // Called before collection move action BEFORE_MOVE_COLLECTION_ACTION: "BEFORE_MOVE_COLLECTION_ACTION", // Called before/after collection move submit/done BEFORE_MOVE_COLLECTION_SUBMIT: "BEFORE_MOVE_COLLECTION_SUBMIT", AFTER_MOVE_COLLECTION_SUBMIT: "AFTER_MOVE_COLLECTION_SUBMIT", // Called before collection copy action BEFORE_COPY_COLLECTION_ACTION: "BEFORE_COPY_COLLECTION_ACTION", // Called before/after collection copy submit/done BEFORE_COPY_COLLECTION_SUBMIT: "BEFORE_COPY_COLLECTION_SUBMIT", AFTER_COPY_COLLECTION_SUBMIT: "AFTER_COPY_COLLECTION_SUBMIT", // Called before/after asset duplicate action BEFORE_DUPLICATE_ASSET_ACTION: "BEFORE_DUPLICATE_ASSET_ACTION", AFTER_DUPLICATE_ASSET_ACTION: "AFTER_DUPLICATE_ASSET_ACTION", // Called before collection duplicate action BEFORE_DUPLICATE_COLLECTION_ACTION: "BEFORE_DUPLICATE_COLLECTION_ACTION", // Called before/after collection duplicate submit/done BEFORE_DUPLICATE_COLLECTION_SUBMIT: "BEFORE_DUPLICATE_COLLECTION_SUBMIT", AFTER_DUPLICATE_COLLECTION_SUBMIT: "AFTER_DUPLICATE_COLLECTION_SUBMIT", // Called before edit collection properties action BEFORE_EDIT_COLLECTION_PROPERTIES_ACTION: "BEFORE_EDIT_COLLECTION_PROPERTIES_ACTION", // Called before/after edit collection properties submit/done BEFORE_EDIT_COLLECTION_PROPERTIES_SUBMIT: "BEFORE_EDIT_COLLECTION_PROPERTIES_SUBMIT", AFTER_EDIT_COLLECTION_PROPERTIES_SUBMIT: "AFTER_EDIT_COLLECTION_PROPERTIES_SUBMIT", // Called before edit asset properties action BEFORE_EDIT_ASSET_PROPERTIES_ACTION: "BEFORE_EDIT_ASSET_PROPERTIES_ACTION", // Called before/after edit asset properties submit/done BEFORE_ASSET_PROPERTIES_SUBMIT: "BEFORE_ASSET_PROPERTIES_SUBMIT", AFTER_ASSET_PROPERTIES_SUBMIT: "AFTER_ASSET_PROPERTIES_SUBMIT", // Called before/after workflow asset submit/done BEFORE_WORKFLOW_ASSET_SUBMIT: "BEFORE_WORKFLOW_ASSET_SUBMIT", AFTER_WORKFLOW_ASSET_SUBMIT: "AFTER_WORKFLOW_ASSET_SUBMIT", // Called before file upload action BEFORE_ASSET_UPLOAD_ACTION: "BEFORE_ASSET_UPLOAD_ACTION", // Called before folder upload action BEFORE_UPLOAD_FOLDER_ACTION: "BEFORE_UPLOAD_FOLDER_ACTION", // Called on preview tab select BEFORE_ASSET_PREVIEW_TAB_ACTION: "BEFORE_ASSET_PREVIEW_TAB_ACTION", // Called on hostory tab select BEFORE_ASSET_HISTORY_TAB_ACTION: "BEFORE_ASSET_HISTORY_TAB_ACTION", // Called on links tab select BEFORE_ASSET_LINK_TAB_ACTION: "BEFORE_ASSET_LINK_TAB_ACTION", // Called on properties tab select BEFORE_ASSET_PROPERTIES_TAB_ACTION: "BEFORE_ASSET_PROPERTIES_TAB_ACTION", // Called on branches tab select BEFORE_ASSET_BRANCHES_TAB_ACTION: "BEFORE_ASSET_BRANCHES_TAB_ACTION", // Called on audit tab select BEFORE_ASSET_AUDIT_TAB_ACTION: "BEFORE_ASSET_AUDIT_TAB_ACTION", // Called before analytics tab select BEFORE_ANALYTICS_TAB_ACTION: "BEFORE_ANALYTICS_TAB_ACTION", // Called before asset version loaded in qpp-asset-version-deck BEFORE_ASSET_VERSIONS_LOADED: "BEFORE_ASSET_VERSIONS_LOADED", // Called after asset version loaded in qpp-asset-version-deck AFTER_ASSET_VERSIONS_LOADED: "AFTER_ASSET_VERSIONS_LOADED", // Called before workflow dialog is open BEFORE_WORKFLOW_DIALOG_OPEN: "BEFORE_WORKFLOW_DIALOG_OPEN", // Called before read only action BEFORE_READ_ONLY_ACTION: "BEFORE_READ_ONLY_ACTION", // Called before revert to version action BEFORE_REVERT_TO_VERSION_ACTION: "BEFORE_REVERT_TO_VERSION_ACTION", // Called after revert to version action AFTER_REVERT_TO_VERSION_ACTION: "AFTER_REVERT_TO_VERSION_ACTION", // Called before/after asset rename action BEFORE_ASSET_RENAME_ACTION: "BEFORE_ASSET_RENAME_ACTION", AFTER_ASSET_RENAME_ACTION: "AFTER_ASSET_RENAME_ACTION", // Called before/after collection rename action BEFORE_COLLECTION_RENAME_ACTION: "BEFORE_COLLECTION_RENAME_ACTION", AFTER_COLLECTION_RENAME_ACTION: "AFTER_COLLECTION_RENAME_ACTION", // Called before/after conversion action BEFORE_STRUCTURED_CONTEXT_CONVERSION_ACTION: "BEFORE_STRUCTURED_CONTEXT_CONVERSION_ACTION", // Called before/after conversion submit BEFORE_STRUCTURED_CONTEXT_CONVERSION_SUBMIT: "BEFORE_STRUCTURED_CONTEXT_CONVERSION_SUBMIT", // Called before/after bulk action submit BEFORE_BULK_SUBMIT: "BEFORE_BULK_SUBMIT", AFTER_BULK_SUBMIT: "AFTER_BULK_SUBMIT" }
subscribers
Type : []
Default value : []

result-matching ""

    No results matching ""