addActionHandler (Klienta API atsauce)

Reģistrē pielāgotu apdarinātāja funkciju Microsoft 365 Copilot darbībai.

Sintakse

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

Parametri

Parametra nosaukums Tips Obligāts Apraksts
actionId virkne Apstrādājamās darbības unikālais identifikators.
actionHandler Funkcija Funkcija, kas jāizsauc, kad darbība tiek aktivizēta. Saņem darbības datu lietderīgo slodzi kā argumentu.
successCallback Funkcija Funkcija, kas jāizsauc, kad operācija ir veiksmīga.
errorCallback Funkcija Funkcija, kas jāizsauc, ja operācija neizdodas.

Atgrieztā vērtība

Tips: Promise<void>

Piezīmes

Jūs varat reģistrēt vairākus apstrādātājus vienam un tam pašam actionId. Tie darbojas secīgi. API klusi ignorē vienas un tās pašas funkcijas atsauces reģistrēšanu divas reizes vienam un tam pašam actionId. API neko nedara, ja Microsoft 365 Copilot nav iespējots.

Iebūvētie darbību ID

Tālāk norādītajiem darbību ID platformas noklusējuma apdarinātāji tiek reģistrēti automātiski. Blakus tiem var pievienot pielāgotus apdarinātājus vai vispirms noņemt noklusējuma apdarinātājus, izmantojot removeDefaultActionHandlers.

Darbības ID Apraksts Datu rekvizīti
MS.PA.CopilotChat.OpenRecord Atver ierakstu. entity (virkne) — tabulas loģiskais nosaukums; recordId (virkne) — ieraksta ID
MS.PA.CopilotChat.NavigateToView Naviģē uz skatu. entity (virkne) — tabulas loģiskais nosaukums; fetchXml (virkne) — FetchXML vaicājums

Piemērs

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 metode
Xrm.Copilot (klienta API atsauce)