getCurrentAgent (client-API-verwijzing)

Retourneert de momenteel actieve Microsoft 365-Copilot-agent of niet gedefinieerd als de agentstatus nog niet bekend is.

Syntax

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

Parameters

Parameternaam Typ Required Description
successCallback Functie Yes Een functie om aan te roepen wanneer de bewerking is geslaagd.
errorCallback Functie Yes Een functie om aan te roepen wanneer de bewerking mislukt.

Retourwaarde

Type: Promise<M365CopilotAgent | undefined> — Wordt omgezet in een M365CopilotAgent-object dat de actieve agent beschrijft of undefined als de agentstatus nog niet is bepaald.

Remarks

Doet niets als Microsoft 365 Copilot niet is ingeschakeld.

De geretourneerde objecten agentId en mode eigenschappen zijn gekoppeld:

  • agentId is een niet-null-tekenreeks en mode is "agentPage" of "mentioned": een agent is actief.
  • agentId is null en mode is null: de gebruiker bevindt zich op de hoofdlijn Microsoft 365 Copilot (geen agent actief).

Voorbeeld

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-interface
Xrm.Copilot (client-API-verwijzing)