アプリ プロファイル マネージャー JavaScript API リファレンス

  • [アーティクル]

アプリ プロファイル マネージャーの JavaScript API 参照は、Customer Service workspace でタブとセッションを管理するためのメソッドとプロパティを含みます。

前提条件

アプリ プロファイル マネージャー API を使用するには、アプリ プロファイル ユーザーまたは生産性向上ツール ユーザーのセキュリティ ロールが必要です。 詳細情報: セキュリティ ロール

セッション管理

次のメソッドとプロパティを使用すると、Customer Service workspace でセッションを管理できます。

メソッド 説明設定
getFocusedSession フォーカスされているセッションのセッション オブジェクトを返します。
getAllSessions 全てのセッションの一意識別子を返します。
getSession 指定されたセッション ID のセッション オブジェクトを返します。
createSession セッション テンプレートに基づいてセッションを作成し、セッションの一意の識別子を返します。
canCreateSession 新しいセッションを作成できる稼働かを示すブール値を返します。
close セッションを閉じます。
focus セッションでフォーカスを設定します。
requestFocus セッションがフォーカスされていない場合、指定セッションに通知インジケーターが表示されます。
Property 説明設定
sessionId 指定セッションの ID。
isDefault セッションがホーム セッションかどうかを示すブール値。
canClose セッションを閉じることができるかどうかを示すブール値。
タイトル セッションのテキスト ラベル。

タブ管理

次のメソッドとプロパティを使用すると、Customer Service workspace でタブを管理できます。

メソッド 説明設定
getFocusedTab フォーカスされているタブのタブ オブジェクトを返します。
getAllTabs セッションのすべてのタブの一意の識別子を返します。
getTab 指定したタブ ID のオブジェクトのスキーマを返します
createTab フォーカスされたセッションでアプリ タブを作成し、タブの一意の識別子を返します。
canCreateTab セッションに対して新しいタブを作成できる稼働かを示すブール値を返します。
closeTab タブ ID のタブ オブジェクトをクローズします。
focusTab タブ ID のタブ オブジェクトを設定します。
refreshTab タブ ID のタブ オブジェクトを最新のものに更新します。
Property 説明設定
tabId タブの ID。
canClose タブを閉じることができるかどうかを示すブール値。
タイトル タブのテキスト ラベル。

コンテキスト管理

次のメソッドを使用すると、Customer Service workspace でセッション コンテキストを管理できます。

メソッド 説明設定
updateContext 自動辞書を設定し、プロバイダーがスラッグの値を追加、変更、削除できるようにします。これにより、更新された値は将来のマクロ呼び出しのために使用できるようになります。

クライアント側のイベント

イベント プロパティ
ON_SESSION_SWITCH セッションが切り替えられると呼び出されます。
ON_SESSION_CLOSED セッションが閉じられるときに呼び出されます。

参照