getCurrentAgent (Referensi API Klien)

Mengembalikan agen Copilot Microsoft 365 yang saat ini aktif, atau tidak terdefinisi jika status agen belum diketahui.

Syntax

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

Parameters

Nama Parameter Type Required Deskripsi
successCallback Function Yes Fungsi untuk memanggil saat operasi berhasil.
errorCallback Function Yes Fungsi untuk memanggil saat operasi gagal.

Mengembalikan Nilai

Jenis: Promise<M365CopilotAgent | undefined> — Menyelesaikan ke objek M365CopilotAgent yang menjelaskan agen aktif, atau undefined jika status agen belum ditentukan.

Remarks

Tidak melakukan apa pun jika Microsoft 365 Copilot tidak diaktifkan.

Properti dan mode objek agentId yang dikembalikan dipasangkan:

  • agentId adalah string non-null dan mode atau "agentPage""mentioned": agen aktif.
  • agentId null dan modenull: pengguna berada di Microsoft 365 Copilot utama (tidak ada agen yang aktif).

Example

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.");
}

Antarmuka M365CopilotAgent
Xrm.Copilot (Referensi API Klien)

  • Last updated on