addActionHandler (referenční informace k rozhraní API klienta)

Zaregistruje vlastní funkci obslužné rutiny pro Microsoft 365 Copilot akci.

Syntax

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

Parameters

Název parametru Typ Povinné Description
actionId řetězec Ano Jedinečný identifikátor akce, která se má zpracovat.
actionHandler Function Ano Funkce, která se má vyvolat při aktivaci akce. Přijme datovou část akce jako argument.
successCallback Function Ano Funkce, která se má volat po úspěšném provedení operace.
errorCallback Function Ano Funkce, která se má volat v případě selhání operace.

Návratová hodnota

Typ: Promise<void>

Remarks

Můžete zaregistrovat více obslužných rutin pro stejnou actionId. Spouští se postupně. Rozhraní API bezobslužně ignoruje registraci stejného odkazu na stejnou funkci dvakrát pro stejnou actionId. Pokud Microsoft 365 Copilot není povolené, rozhraní API nic nedělá.

Předdefinovaná ID akcí

Id následujících akcí mají automaticky zaregistrované výchozí obslužné rutiny platformy. Můžete přidat vlastní obslužné rutiny vedle nich nebo nejprve odebrat výchozí obslužné rutiny pomocí removeDefaultActionHandlers.

ID akce Description Vlastnosti dat
MS.PA.CopilotChat.OpenRecord Otevře záznam. entity (řetězec) – logický název tabulky; recordId (string) – ID záznamu
MS.PA.CopilotChat.NavigateToView Přejde do zobrazení. entity (řetězec) – logický název tabulky; fetchXml (string) – dotaz FetchXML

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

metoda removeActionHandler
Xrm.Copilot (referenční informace k rozhraní API klienta)