getCurrentAgent (справка за API на клиент)

Връща текущо активния Microsoft 365 агент на Copilot или неопределен, ако състоянието на агента все още не е известно.

Синтаксис

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

Параметри

Име на параметър Тип Задължителни Описание
successCallback Функция Да Функция, която да извика, когато операцията е успешна.
errorCallback Функция Да Функция, която да се извика, когато операцията е неуспешна.

Върната стойност

Тип: Promise<M365CopilotAgent | undefined> – Преобразува се в обект M365CopilotAgent , описващ активния агент, или undefined ако състоянието на агента все още не е определено.

Забележки

Не прави нищо, ако Microsoft 365 Copilot не е разрешен.

Върнатите обекти agentId и mode свойства са сдвоени:

  • agentId е низ, който не е Null, и mode е "agentPage" или "mentioned": агентът е активен.
  • agentId е null, а mode е null: потребителят е в главното Microsoft 365 Copilot (няма активен агент).

Пример

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

M365CopilotAgent интерфейс
Xrm.Copilot (препратка към API на клиент)