getCurrentAgent (klient-API-reference)

Returnerer den aktive Microsoft Copilot-agent eller udefineres, hvis agenttilstanden endnu ikke er kendt.

Syntaks

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

Parametre

Parameternavn	Type	Påkrævet	Beskrivelse
successCallback	Function	Yes	En funktion, der skal kaldes, når handlingen lykkes.
errorCallback	Function	Yes	En funktion, der skal kaldes, når handlingen mislykkes.

Returværdi

Type: Promise<M365CopilotAgent | undefined> – fortolkes som et M365CopilotAgent-objekt , der beskriver den aktive agent, eller undefined hvis agenttilstanden endnu ikke er bestemt.

Remarks

Gør ingenting, hvis Microsoft Copilot ikke er aktiveret.

Det returnerede objekts agentId og mode egenskaber er parret:

• agentId er en streng, der ikke er null, og mode er "agentPage" eller "mentioned": en agent er aktiv.
• agentIder null og mode er null: brugeren er på hovedlinjen Microsoft Copilot (ingen agent aktiv).

Eksempel

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

Relaterede artikler

Grænsefladen M365CopilotAgent
Xrm.Copilot (klient-API-reference)