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

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

Syntax

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

Parameters

Имя параметра	Тип	Обязательный	Description
successCallback	Function	Да	Функция, вызываемая при успешном выполнении операции.
errorCallback	Function	Да	Функция, вызываемая при сбое операции.

Возвращаемое значение

Тип: Promise<M365CopilotAgent | undefined> — разрешает объект M365CopilotAgent , описывающий активный агент, или undefined если состояние агента еще не определено.

Remarks

Не делает ничего, если Microsoft 365 Copilot не включен.

Возвращенный объект agentId и mode свойства объединяются:

• agentId является строкой, отличной от null, и mode является "agentPage" или "mentioned": агент активен.
• agentId null и modenull: пользователь находится на главной 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 клиента)