getCurrentAgent (Rujukan API Pelanggan)

Mengembalikan ejen Microsoft Copilot agent yang sedang aktif, atau tidak ditakrifkan jika status ejen belum diketahui.

Syntax

Xrm.Copilot.getCurrentAgent().then(successCallback, errorCallback);

Parameter

Nama Parameter Jenis Diperlukan Perihalan
successCallback Fungsi Ya Fungsi untuk memanggil apabila operasi berjaya.
errorCallback Fungsi Ya Fungsi untuk memanggil apabila operasi gagal.

Nilai Kembali

Jenis: Promise<M365CopilotAgent | undefined> — Diselesaikan kepada objek M365CopilotAgent yang menerangkan ejen aktif, atau undefined jika keadaan ejen belum ditentukan lagi.

Kenyataan

Tiada tindakan jika Microsoft Copilot tidak diaktifkan.

Objek agentId dan mode sifat yang dikembalikan dipasangkan:

  • agentId ialah rentetan bukan nol dan mode ialah "agentPage" atau "mentioned": ejen aktif.
  • agentIdialah null dan mode ialah null: pengguna berada di Microsoft Copilot utama (tiada ejen aktif).

Contoh

const agent = await Xrm.Copilot.getCurrentAgent();
if (agent && agent.agentId) {
    console.log(`Active agent: ${agent.agentId}, mode: ${agent.mode}`);
} else if (agent) {
    console.log("User is on mainline M365 Copilot (no agent).");
} else {
    console.log("Agent state not yet determined.");
}

Antara muka M365CopilotAgent
Xrm.Copilot (Rujukan API Pelanggan)