addActionHandler (klient-API-reference)

Registrerer en brugerdefineret handlerfunktion for en Microsoft 365 Copilot handling.

Syntaks

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

Parametre

Parameternavn	Type	Påkrævet	Beskrivelse
actionId	streng	Yes	Det entydige id for den handling, der skal håndteres.
actionHandler	Function	Yes	Den funktion, der skal aktiveres, når handlingen udløses. Modtager handlingens datadata som et argument.
successCallback	Function	Yes	En funktion, der skal kaldes, når handlingen lykkes.
errorCallback	Function	Yes	En funktion, der skal kaldes, når handlingen mislykkes.

Returværdi

Type: Promise<void>

Remarks

Du kan registrere flere handlere for den samme actionId. De kører sekventielt. API'en ignorerer uovervåget registrering af den samme funktionsreference to gange for den samme actionId. API'en gør ingenting, hvis Microsoft 365 Copilot ikke er aktiveret.

Indbyggede handlings-id'er

Følgende handlings-id'er har automatisk registreret platformstandardhandlere. Du kan tilføje brugerdefinerede handlere ved siden af dem eller fjerne standardhandlerne først ved hjælp af removeDefaultActionHandlers.

Handlings-id	Beskrivelse	Dataegenskaber
MS.PA.CopilotChat.OpenRecord	Åbner en post.	entity (streng) – tabel logisk navn; recordId (streng) – post-id
MS.PA.CopilotChat.NavigateToView	Navigerer til en visning.	entity (streng) – tabel logisk navn; fetchXml (streng) – FetchXML-forespørgsel

Eksempel

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

Relaterede artikler

removeActionHandler-metode
Xrm.Copilot (klient-API-reference)