getCurrentAgent (Rujukan API Pelanggan)

Mengembalikan ejen Microsoft 365 Copilot agent yang sedang aktif, atau tidak ditakrifkan jika keadaan 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

Tidak melakukan apa-apa jika Microsoft 365 Copilot tidak didayakan.

Objek agentId dan mode sifat yang dikembalikan dipasangkan:

  • agentId ialah rentetan bukan nol dan mode ialah "agentPage" atau "mentioned": ejen aktif.
  • agentId ialah null dan mode ialah null: pengguna berada di Microsoft 365 Copilot talian 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)