getCurrentAgent (Referência à API do cliente)

Devolve o Microsoft 365 agente do Copilot atualmente ativo, ou não está definido se o estado do agente ainda não for conhecido.

Sintaxe

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

Parameters

Nome do parâmetro Tipo Obrigatório Description
successCallback Function Yes Uma função a ser chamada quando a operação for bem-sucedida.
errorCallback Function Yes Uma função para chamar quando a operação falhar.

Valor de retorno

Tipo: Promise<M365CopilotAgent | undefined> — Resolve para um objeto M365CopilotAgent que descreve o agente ativo, ou undefined se o estado do agente ainda não for determinado.

Remarks

Não faz nada se o Microsoft 365 Copilot não estiver ativado.

Os objetos agentId devolvidos e mode as propriedades são emparelhados:

  • agentId é uma cadeia não nula e mode é "agentPage" ou "mentioned": um agente é ativo.
  • agentId é null e mode é null: o utilizador está na linha principal Microsoft 365 Copilot (sem agente ativo).

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

Interface M365CopilotAgent
Xrm.Copilot (referência da API do cliente)

  • Last updated on