アプリ プロファイル マネージャー JavaScript API リファレンスには、Copilot Service ワークスペースでタブとセッションを管理するためのメソッドとプロパティが含まれています。
前提条件
アプリ プロファイル マネージャー API を使用するには、アプリ プロファイル ユーザーまたは生産性向上ツールのユーザー セキュリティ ロールが必要です。 詳細: セキュリティ ロール
セッション管理
次の方法とプロパティを使用すると、Copilot Service ワークスペースでセッションを管理できます。
| メソッド | Description |
|---|---|
| getFocusedSession | フォーカスされているセッションのセッション オブジェクトを返します。 |
| getAllSessions | すべてのセッションの一意の識別子を返します。 |
| getSession | 指定したセッション ID のセッション オブジェクトを返します。 |
| createSession | セッションテンプレートに基づいてセッションを作成し、セッションの一意の識別子を返します。 |
| canCreateSession | 新しいセッションを作成できるかどうかを示すブール値を返します。 |
| 閉める | セッションを閉じます。 |
| 焦点 | セッションにフォーカスを設定します。 |
| リクエストフォーカス | セッションにフォーカスが合っていない場合、特定のセッションに通知インジケータを表示します。 |
| プロパティ | Description |
|---|---|
| セッション ID | 特定のセッションの ID。 |
| デフォルト | セッションがホームセッションであるかどうかを示すブール値。 |
| 閉じる | セッションを閉じることができるかどうかを示すブール値。 |
| title | セッションのテキストラベル。 |
タブ管理
次の方法とプロパティを使用すると、Copilot サービス ワークスペースのタブを管理できます。
| メソッド | Description |
|---|---|
| getFocusedTab | フォーカスされているタブのタブ オブジェクトを返します。 |
| getAllTabs | セッションのすべてのタブの一意の識別子を返します。 |
| getTab (取得タブ) | 指定したタブ ID のタブ オブジェクトを返します。 |
| createTab | フォーカスされたセッションにタブを作成し、タブの一意の識別子を返します。 |
| canCreateタブ | セッションに対して新しいタブを作成できるかどうかを示すブール値を返します。 |
| closeTab | タブ ID のタブ オブジェクトを閉じます。 |
| focusTab | タブ ID のタブ オブジェクトにフォーカスを設定します。 |
| refreshTab | タブ ID のタブ オブジェクトを更新します。 |
| プロパティ | Description |
|---|---|
| tabId | タブの ID。 |
| 閉じる | タブを閉じることができるかどうかを示すブール値。 |
| title | タブのテキストラベル。 |
コンテキスト管理
次の方法を使用すると、Copilot Service ワークスペースでセッション コンテキストを管理できます。
| メソッド | Description |
|---|---|
| updateContext | オートメーション ディクショナリを設定し、プロバイダーがスラッグの値を追加、変更、削除できるようにします。更新された値は、将来マクロを呼び出すために使用できます。 |
クライアント側のイベント
| Event | Description |
|---|---|
| ON_SESSION_SWITCH | セッションが切り替えられると呼び出されます。 |
| ON_SESSION_CLOSED | セッションが閉じられたときに呼び出されます。 |