getCurrentAgent (Referencia á API do cliente)

Devolve o Microsoft 365 Copilot agent actualmente activo, ou indefinido se o estado do axente aínda non se coñece.

Sintaxe

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

Parámetros

Nome do parámetro Tipo Necesario Descripción
successCallback Función Si Unha función a chamar cando a operación teña éxito.
errorCallback Función Si Unha función a chamar cando a operación falla.

Valor devolto

Tipo: Promise<M365CopilotAgent | undefined> — Resólvese a un obxecto M365CopilotAgent que describe o axente activo, ou undefined se o estado do axente aínda non está determinado.

Observacións

Non fai nada se Microsoft 365 Copilot non está activado.

Os obxectos agentId devoltos e mode as propiedades están emparellados:

  • agentId é unha cadea non nula e mode é "agentPage" ou "mentioned": un axente está activo.
  • agentId é null e mode é null: o usuario está na liña principal Microsoft 365 Copilot (sen axente activo).

Exemplo

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

Interface M365CopilotAgent
Xrm.Copilot (Referencia da API do cliente)