getCurrentAgent (Client-API-Referenz)

Gibt die derzeit aktive Microsoft 365-Copilot-Agent oder nicht definiert zurück, wenn der Agentstatus noch nicht bekannt ist.

Syntax

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

Parameter

Parametername Typ Erforderlich Beschreibung
successCallback Funktion Yes Eine Funktion zum Aufrufen, wenn der Vorgang erfolgreich war.
errorCallback Funktion Yes Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug.

Rückgabewert

Typ: Promise<M365CopilotAgent | undefined> - Löst ein M365CopilotAgent -Objekt auf, das den aktiven Agent beschreibt, oder undefined wenn der Agentstatus noch nicht bestimmt ist.

Remarks

Führt nichts aus, wenn Microsoft 365 Copilot nicht aktiviert ist.

Die zurückgegebenen Objekte agentId und mode Eigenschaften sind gekoppelt:

  • agentId ist eine nicht null-Zeichenfolge und mode ist "agentPage" oder "mentioned": ein Agent ist aktiv.
  • agentId ist null und mode ist null: Der Benutzer befindet sich in der Hauptzeile Microsoft 365 Copilot (kein Agent aktiv).

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

M365CopilotAgent-Schnittstelle
Xrm.Copilot (Client-API-Referenz)

  • Last updated on