現在アクティブな Microsoft 365 Copilot エージェントを返します。エージェントの状態がまだ不明な場合は未定義です。
Syntax
Xrm.Copilot.getCurrentAgent().then(successCallback, errorCallback);
Parameters
| パラメーター名 | タイプ | 必須 | Description |
|---|---|---|---|
successCallback |
Function | はい | 処理が成功したときに呼び出す関数。 |
errorCallback |
Function | はい | 処理が失敗したときに呼び出す関数。 |
戻り値
型: Promise<M365CopilotAgent | undefined> — アクティブなエージェントを記述する M365CopilotAgent オブジェクトに解決するか、エージェントの状態がまだ決定されていない場合は undefined します。
Remarks
Microsoft 365 Copilotが有効になっていない場合は何も行いません。
返されたオブジェクトの agentId プロパティと mode プロパティはペアになります。
-
agentIdは null 以外の文字列で、modeが"agentPage"または"mentioned": エージェントがアクティブです。 -
agentIdがnullで、modeがnull: ユーザーがメインライン Microsoft 365 Copilotにいます (エージェントがアクティブでない)。
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.");
}