addActionHandler (informazioni di riferimento sulle API client)

Registra una funzione del gestore personalizzata per un'azione Microsoft 365 Copilot.

Syntax

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

Parametri

Nome del parametro TIPO Obbligatorio Description
actionId string Yes Identificatore univoco dell'azione da gestire.
actionHandler Function Yes Funzione da richiamare quando viene attivata l'azione. Riceve il payload dei dati dell'azione come argomento.
successCallback Function Yes Funzione da chiamare quando l'operazione ha esito positivo.
errorCallback Function Yes Funzione da chiamare quando l'operazione ha esito negativo.

Valore restituito

Tipo: Promise<void>

Remarks

È possibile registrare più gestori per lo stesso actionIdoggetto . Vengono eseguiti in sequenza. L'API ignora automaticamente la registrazione dello stesso riferimento di funzione due volte per lo stesso actionIdoggetto . L'API non esegue alcuna operazione se Microsoft 365 Copilot non è abilitato.

ID azione predefiniti

Gli ID azione seguenti includono gestori predefiniti della piattaforma registrati automaticamente. È possibile aggiungere gestori personalizzati insieme o rimuovere prima i gestori predefiniti usando removeDefaultActionHandlers.

ID azione Description Proprietà dei dati
MS.PA.CopilotChat.OpenRecord Apre un record. entity (string) — nome logico della tabella; recordId (string) — ID record
MS.PA.CopilotChat.NavigateToView Passa a una visualizzazione. entity (string) — nome logico della tabella; fetchXml (string) — Query FetchXML

Example

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, metodo
Xrm.Copilot (Informazioni di riferimento sulle API client)

  • Last updated on