raiseEvent (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0
Invokes the associated subscriber for the event.
Note
If you've created custom events using the addHandler method, then you can raise those events by passing the event name as parameter in this method.
Syntax
Microsoft.CIFramework.raiseEvent(eventName, eventInputParameters, correlationId);
Parameters
Name | Type | Required | Description |
---|---|---|---|
eventName | String | Yes | Name of the event whose handler needs to be invoked. |
eventInputParameters | JSON String | Yes | The input parameters that need to be passed to the handler function. |
correlationId | GUID | No | Is used to group all related API calls together for diagnostic telemetry. |
Return value
Promise with a value as Boolean.
Example
// Let there be an event registered to a subscriber.
handlerFunction = function(eventInput)
{
console.log(eventInput);
if(eventInput != null && eventInput != undefined && eventInput.size > 0)
{
inputData = eventInput.get("value");
correlationId = eventInput.get("correlationId");
console.log(inputData + " " + correlationId);
}
return Promise.resolve();
}
Microsoft.CIFramework.addHandler("oncustomevent", handlerFunction);
//Use raiseEvent API to invoke the subscribed handler of the event.
Microsoft.CIFramework.raiseEvent("oncustomevent", "test input value");
//In the main UCI page
Microsoft.CIFramework.addHandler("widgetEvent", handlerFunction);
///In the widget code
Microsoft.CIFramework.raiseEvent("widgetEvent", eventInput);
//In the widget code
Microsoft.CIFramework.addHandler("mainPageEvent", handlerFunction);
//In the main UCI page
Microsoft.CIFramework.raiseEvent("mainPageEvent", eventInput);
See also
onClickToAct
onModeChanged
onPageNavigate
onSendKBArticle
onSizeChanged
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應