addActionHandler (Rujukan API Klien)

Mendaftarkan fungsi pengendali tersuai untuk tindakan Microsoft 365 Copilot.

Syntax

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

Parameter

Nama Parameter Jenis Diperlukan Perihalan
actionId rentetan Ya Pengecam unik tindakan yang perlu dikendalikan.
actionHandler Fungsi Ya Fungsi untuk memanggil apabila tindakan dicetuskan. Menerima muatan data tindakan sebagai hujah.
successCallback Fungsi Ya Fungsi untuk memanggil apabila operasi berjaya.
errorCallback Fungsi Ya Fungsi untuk memanggil apabila operasi gagal.

Nilai Kembali

Jenis: Promise<void>

Kenyataan

Anda boleh mendaftarkan berbilang pengendali untuk perkara yang sama actionId. Mereka berjalan secara berurutan. API secara senyap mengabaikan pendaftaran rujukan fungsi yang sama dua kali untuk yang sama actionId. API tidak melakukan apa-apa jika Microsoft 365 Copilot tidak didayakan.

ID tindakan terbina dalam

ID tindakan berikut mempunyai pengendali lalai platform yang didaftarkan secara automatik. Anda boleh menambah pengendali tersuai di sebelahnya atau mengalih keluar pengendali lalai terlebih dahulu dengan menggunakan removeDefaultActionHandlers.

ID Tindakan Perihalan Sifat data
MS.PA.CopilotChat.OpenRecord Membuka rekod. entity (rentetan) — nama logik jadual; recordId (rentetan) — ID rekod
MS.PA.CopilotChat.NavigateToView Menavigasi ke pandangan. entity (rentetan) — nama logik jadual; fetchXml (rentetan) — Pertanyaan FetchXML

Contoh

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

kaedah removeActionHandler
Xrm.Copilot (Rujukan API Pelanggan)

  • Last updated on