getCurrentAgent (referencia de api de cliente)

Devuelve el agente de Copilot activo actualmente de Microsoft 365 o indefinido si aún no se conoce el estado del agente.

Syntax

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

Parámetros

Nombre de parámetro Tipo Obligatorio Descripción
successCallback Function Una función para llamar a la operación es correcta.
errorCallback Function Una función a la que se llama cuando la operación tiene error.

Valor devuelto

Tipo: : Promise<M365CopilotAgent | undefined> se resuelve en un objeto M365CopilotAgent que describe el agente activo o undefined si el estado del agente aún no está determinado.

Remarks

No hace nada si Microsoft 365 Copilot no está habilitado.

Las propiedades y mode del agentId objeto devuelto se emparejan:

  • agentId es una cadena que no es null y mode es "agentPage" o "mentioned": un agente está activo.
  • agentId es null y mode es null: el usuario está en la línea principal Microsoft 365 Copilot (sin agente activo).

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

Interfaz M365CopilotAgent
Xrm.Copilot (referencia de la API cliente)