getCurrentAgent (довідник з API клієнта)

Повертає поточний активний агент Copilot Microsoft 365 або невизначений, якщо стан агента ще не відомий.

Синтаксис

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, а 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 клієнта)