addActionHandler (asiakkaan ohjelmointirajapinnan viittaus)

Rekisteröi mukautetun käsittelijän funktion Microsoft 365 Copilot.

Syntax

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

Parametrit

Parametrin nimi Type Pakollinen Description
actionId merkkijono Yes Käsiteltävän toiminnon yksilöllinen tunnus.
actionHandler Function Yes Funktio, joka käynnistyy, kun toiminto käynnistetään. Vastaanottaa toiminnon tietojen tiedot argumenttina.
successCallback Function Yes Funktio, jota kutsutaan, kun toiminto onnistuu.
errorCallback Function Yes Funktio, jota kutsutaan, kun toiminto epäonnistuu.

Palautusarvo

Tyyppi: Promise<void>

Huomautuksia

Voit rekisteröidä useita käsittelijöitä samalle actionIdlle. Ne suoritetaan peräkkäin. Ohjelmointirajapinta ohittaa automaattisesti saman funktioviittauksen rekisteröimisen kahdesti samassa actionId:ssa. Ohjelmointirajapinta ei tee mitään, jos Microsoft 365 Copilot ei ole käytössä.

Sisäiset toimintotunnukset

Seuraavat toimintotunnukset on rekisteröity automaattisesti ympäristön oletuskäsittelijöille. Voit lisätä mukautettuja käsittelijöitä niiden rinnalle tai poistaa oletuskäsittelijät ensin käyttämällä removeDefaultActionHandlers-funktiota.

Toimenpiteen tunnus Description Tietojen ominaisuudet
MS.PA.CopilotChat.OpenRecord Avaa tietueen. entity (merkkijono) – taulukon looginen nimi; recordId (merkkijono) – tietuetunnus
MS.PA.CopilotChat.NavigateToView Siirtyy näkymään. entity (merkkijono) – taulukon looginen nimi; fetchXml (merkkijono) — FetchXML-kysely

Esimerkki

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-menetelmä
Xrm.Copilot (asiakkaan ohjelmointirajapinnan viittaus)