addActionHandler (client-API-verwijzing)

Registreert een aangepaste handlerfunctie voor een Microsoft 365 Copilot-actie.

Syntax

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

Parameters

Parameternaam	Typ	Required	Description
actionId	string	Yes	De unieke id van de actie die moet worden verwerkt.
actionHandler	Functie	Yes	De functie die moet worden aangeroepen wanneer de actie wordt geactiveerd. Hiermee ontvangt u de nettolading van de gegevens van de actie als argument.
successCallback	Functie	Yes	Een functie om aan te roepen wanneer de bewerking is geslaagd.
errorCallback	Functie	Yes	Een functie om aan te roepen wanneer de bewerking mislukt.

Retourwaarde

Typ: Promise<void>

Remarks

U kunt meerdere handlers registreren voor hetzelfde actionId. Ze worden opeenvolgend uitgevoerd. De API negeert het registreren van dezelfde functieverwijzing tweemaal voor hetzelfde actionId. De API doet niets als Microsoft 365 Copilot niet is ingeschakeld.

Ingebouwde actie-id's

De volgende actie-id's hebben platformstandaardhandlers automatisch geregistreerd. U kunt ernaast aangepaste handlers toevoegen of eerst de standaardhandlers verwijderen met removeDefaultActionHandlers.

Actie-ID	Description	Gegevenseigenschappen
MS.PA.CopilotChat.OpenRecord	Hiermee opent u een record.	entity (tekenreeks) — logische tabelnaam; recordId (tekenreeks) — record-id
MS.PA.CopilotChat.NavigateToView	Hiermee gaat u naar een weergave.	entity (tekenreeks) — logische tabelnaam; fetchXml (tekenreeks) — FetchXML-query

Voorbeeld

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

Verwante artikelen

methode removeActionHandler
Xrm.Copilot (client-API-verwijzing)