addActionHandler (Client-API-Referenz)

Registriert eine benutzerdefinierte Handlerfunktion für eine Microsoft 365 Copilot-Aktion.

Syntax

Xrm.Copilot.addActionHandler(actionId, actionHandler).then(successCallback, errorCallback);

Parameter

Parametername Typ Erforderlich Beschreibung
actionId string Yes Der eindeutige Bezeichner der zu behandelnden Aktion.
actionHandler Funktion Yes Die Funktion, die aufgerufen werden soll, wenn die Aktion ausgelöst wird. Empfängt die Datennutzlast der Aktion als Argument.
successCallback Funktion Yes Eine Funktion zum Aufrufen, wenn der Vorgang erfolgreich war.
errorCallback Funktion Yes Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug.

Rückgabewert

Typ: Promise<void>

Remarks

Sie können mehrere Handler für dasselbe actionIdregistrieren. Sie werden sequenziell ausgeführt. Die API ignoriert automatisch das Registrieren desselben Funktionsverweises zweimal für dasselbe actionId. Die API führt nichts aus, wenn Microsoft 365 Copilot nicht aktiviert ist.

Integrierte Aktions-IDs

Bei den folgenden Aktions-IDs werden plattformstandardbasierte Handler automatisch registriert. Sie können benutzerdefinierte Handler zusammen hinzufügen oder die Standardhandler zuerst mithilfe von removeDefaultActionHandlers entfernen.

Aktions-ID Beschreibung Dateneigenschaften
MS.PA.CopilotChat.OpenRecord Öffnet einen Datensatz. entity (Zeichenfolge) — logischer Tabellenname; recordId (Zeichenfolge) — Datensatz-ID
MS.PA.CopilotChat.NavigateToView Navigiert zu einer Ansicht. entity (Zeichenfolge) — logischer Tabellenname; fetchXml (Zeichenfolge) – FetchXML-Abfrage

Example

const handler = async ({ entity, recordId }) => {
    // Open the record in a side pane instead of navigating away
    const pane = Xrm.App.sidePanes.createPane({ canClose: true });
    await pane.navigate({ pageType: "entityrecord", entityName: entity, entityId: recordId });
};

await Xrm.Copilot.addActionHandler("My.Namespace.MyActionMessage", handler);

removeActionHandler-Methode
Xrm.Copilot (Client-API-Referenz)

  • Last updated on