getCurrentAgent (referenční informace k rozhraní API klienta)

Vrátí aktuálně aktivní agent Copilota Microsoftu 365 nebo nedefinovaný, pokud stav agenta ještě není známý.

Syntax

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

Parameters

Název parametru	Typ	Povinné	Description
successCallback	Function	Ano	Funkce, která se má volat po úspěšném provedení operace.
errorCallback	Function	Ano	Funkce, která se má volat v případě selhání operace.

Návratová hodnota

Typ: Promise<M365CopilotAgent | undefined> – Přeloží se na objekt M365CopilotAgent popisující aktivního agenta nebo undefined pokud stav agenta ještě není určen.

Remarks

Pokud Microsoft 365 Copilot není povolená, nic nedělá.

Vrácený objekt agentId a mode vlastnosti jsou spárovány:

• agentId je nenulový řetězec a mode je "agentPage" nebo "mentioned": agent je aktivní.
• agentId je null a mode je null: uživatel je na hlavním Microsoft 365 Copilot (bez aktivního agenta).

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

Související články

M365CopilotAgent – rozhraní
Xrm.Copilot (referenční informace k rozhraní API klienta)