getCurrentAgent (kliendi API viide)

Tagastab praegu aktiivse Microsoft 365 Copiloti agent või määratlemata, kui agendi olek pole veel teada.

Süntaks

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

Parameetrid

Parameetri nimi Tüüp Nõutav Kirjeldus
successCallback Funktsioon Jah Funktsioon, mida kutsuda, kui toiming õnnestub.
errorCallback Funktsioon Jah Funktsioon, mida kutsuda, kui toiming nurjub.

Tagastusväärtus

Tüüp: Promise<M365CopilotAgent | undefined> – laheneb aktiivset agenti kirjeldava M365CopilotAgenti objektiks või undefined kui agendi olekut pole veel määratud.

Märkused

Ei tee midagi, kui Microsoft 365 Copilot pole lubatud.

Tagastatud objektid agentId ja mode atribuudid on seotud:

  • agentId on nullistring ja mode on "agentPage" või "mentioned": agent on aktiivne.
  • agentId on null ja mode on null: kasutaja on põhijoone Microsoft 365 Copilot (agent pole aktiivne).

Näide

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

M365CopilotAgenti liides
Xrm.Copilot (kliendi API viide)