Udostępnij przez

raiseEvent (dokumentacja interfejsu API języka JavaScript) dla Dynamics 365 Channel Integration Framework 1.0

Wywołuje skojarzonego subskrybenta zdarzenia.

Uwaga / Notatka

Jeśli zdarzenia niestandardowe zostały utworzone przy użyciu metody addHandler, możesz zgłosić te zdarzenia, przekazując nazwę zdarzenia jako parametr w tej metodzie.

Składnia

Microsoft.CIFramework.raiseEvent(eventName, eventInputParameters, correlationId);

Parametry

Name Typ Wymagane Description
eventName (nazwa_wydarzenia) Sznurek Tak Nazwa zdarzenia, którego procedura obsługi musi zostać wywołana.
eventInputParameters (parametry) Ciąg JSON Tak Parametry wejściowe, które należy przekazać do funkcji obsługi.
correlationId (identyfikator korelacji) GUID Nie. Służy do grupowania wszystkich powiązanych wywołań interfejsu API na potrzeby telemetrii diagnostycznej.

Wartość zwracana

Obietnica z wartością w postaci wartości logicznej.

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);

onClickToAct
onModeChanged
onPageNavigate (Nawigacja po stronie)
onSendKBArticle
onSizeChanged

  • Last updated on