getCurrentAgent (référence sur l’API cliente)

Retourne le assistant Copilot Microsoft 365 actif ou non défini si l’état de l’agent n’est pas encore connu.

Syntax

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

Paramètres

Nom du paramètre Catégorie Required Description
successCallback Function Oui Fonctionnalité à appeler lorsque l’opération aboutit.
errorCallback Function Oui Fonction à appeler lorsque l’opération échoue.

Valeur de retour

Type : : Promise<M365CopilotAgent | undefined> résout un objet M365CopilotAgent décrivant l’agent actif ou undefined si l’état de l’agent n’est pas encore déterminé.

Remarks

Ne fait rien si Microsoft 365 Copilot n'est pas activé.

Les propriétés et mode les propriétés de l’objet agentId retourné sont jumelées :

  • agentId est une chaîne non null et mode est "agentPage" ou "mentioned": un agent est actif.
  • agentId est null et mode est null : l’utilisateur est sur le Microsoft 365 Copilot de ligne principale (aucun agent actif).

Exemple

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

Interface M365CopilotAgent
Xrm.Copilot (référence de l’API client)