getCurrentAgent (referência da API do cliente)

Retorna o microsoft 365 agente do Copilot atualmente ativo ou indefinido 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 Descrição
successCallback Função Yes Uma função a ser chamada quando a operação for bem-sucedida.
errorCallback Função Yes Uma função a ser chamada 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 foi determinado.

Remarks

Não fará nada se Microsoft 365 Copilot não estiver habilitado.

As propriedades e mode o agentId objeto retornado são emparelhados:

  • agentId é uma cadeia de caracteres não nula e mode é "agentPage" ou "mentioned": um agente está ativo.
  • agentId é null e mode é null: o usuário está na linha principal Microsoft 365 Copilot (nenhum 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 cliente)

  • Last updated on