addActionHandler (Klient-API-referanse)

Registrerer en egendefinert behandlingsfunksjon for en Microsoft 365 Copilot handling.

Syntaks

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

Parametre

Parameternavn Type Påkrevd Beskrivelse
actionId streng Yes Den unike identifikatoren for handlingen som skal håndteres.
actionHandler Function Yes Funksjonen som skal aktiveres når handlingen utløses. Mottar handlingens datanyttelast som et argument.
successCallback Function Yes En funksjon som skal kalles når operasjonen er vellykket.
errorCallback Function Yes En funksjon som skal kalles når operasjonen mislykkes.

Returverdi

Type: Promise<void>

Merknader

Du kan registrere flere behandlere for samme actionId. De løper sekvensielt. API-en ignorerer stille registrering av samme funksjonsreferanse to ganger for samme actionId. API-en gjør ingenting hvis Microsoft 365 Copilot ikke er aktivert.

Innebygde handlings-ID-er

Følgende handlings-ID-er har registrert plattformstandardbehandlinger automatisk. Du kan legge til egendefinerte behandlere ved siden av dem, eller fjerne standardbehandlingene først ved hjelp av removeDefaultActionHandlers.

Handlings-ID Beskrivelse Dataegenskaper
MS.PA.CopilotChat.OpenRecord Åpner en post. entity (streng) – tabell logisk navn; recordId (streng) – post-ID
MS.PA.CopilotChat.NavigateToView Navigerer til en visning. entity (streng) – tabell logisk navn; fetchXml (streng) – FetchXML-spørring

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

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

  • Last updated on