addActionHandler (Referensi API Klien)

Mendaftarkan fungsi handler kustom untuk tindakan Microsoft 365 Copilot.

Syntax

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

Parameters

Nama Parameter Type Required Deskripsi
actionId string Yes Pengidentifikasi unik tindakan yang akan ditangani.
actionHandler Function Yes Fungsi yang akan dipanggil saat tindakan dipicu. Menerima payload data tindakan sebagai argumen.
successCallback Function Yes Fungsi untuk memanggil saat operasi berhasil.
errorCallback Function Yes Fungsi untuk memanggil saat operasi gagal.

Mengembalikan Nilai

Jenis: Promise<void>

Remarks

Anda dapat mendaftarkan beberapa handler untuk yang sama actionId. Mereka berjalan secara berurutan. API secara diam-diam mengabaikan pendaftaran referensi fungsi yang sama dua kali untuk yang sama actionId. API tidak melakukan apa pun jika Microsoft 365 Copilot tidak diaktifkan.

ID tindakan bawaan

ID tindakan berikut memiliki handler default platform yang terdaftar secara otomatis. Anda dapat menambahkan handler kustom bersama mereka, atau menghapus handler default terlebih dahulu dengan menggunakan removeDefaultActionHandlers.

ID Tindakan Deskripsi Properti data
MS.PA.CopilotChat.OpenRecord Membuka rekaman. entity (string) — nama logis tabel; recordId (string) — ID rekaman
MS.PA.CopilotChat.NavigateToView Menavigasi ke tampilan. entity (string) — nama logis tabel; fetchXml (string) — Kueri 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);

metode removeActionHandler
Xrm.Copilot (Referensi API Klien)

  • Last updated on