Dynamics 365 チャネル統合フレームワーク 2.0 の Microsoft.CIFramework メソッド (JavaScript API リファレンス)

Microsoft CIFramework は、JavaScript API を使用して、Dynamics 365 モデル駆動型アプリの通信パネル (ウィジェット)、通知、アプリケーションタブ、セッション、レコード、およびフォームを管理するメソッドを提供します。

重要

API は、組織内で構成されているアクティブなチャネルプロバイダーからのみサポートされます。
他の API を呼び出す前に、 CIFInitDoneイベントハンドラを呼び出す必要があります。
API のタイムアウト制限は 100 秒です。 API が 100 秒以内に実行されない場合は、パラメーターまたはスコープを変更して再度実行する必要があります。

通信のパネル管理の API

通信パネルは、エージェントとして顧客と対話する場です。 Channel Integration Framework 2.0 を使用して構築されたパートナーウィジェットは、このパネルにロードされます。このバージョンのウィジェットはセッションパネルの左側に表示され、ドッキング、最小化、および非表示モードをサポートします。

コミュニケーションパネル (ウィジェット) の状態を管理するには、以下の API を使用します。

メソッド	Description
setWidth	すべてのセッションのパネル幅を設定します。
getWidth	パネルの幅をピクセル単位で取得します。
setMode	パネルの状態を設定します。
getMode	パネルの状態を設定します。

CRUD 操作 API

エンティティレコードに対して CRUD オペレーションを実行するには、次の API を使用します。

メソッド	Description
createRecord	エンティティレコードを作成します。
retrieveRecord	エンティティレコードを取得します。
updateRecord	エンティティレコードを更新します。
deleteRecord	エンティティレコードを削除します。

通知管理 API

着信会話に関する通知を表示またはキャンセルするには、次の API を使用します。

メソッド	Description
notifyEvent	着信会話についてエージェントに通知するために使用できる通知を表示します。
cancelEvent	`notifyEvent` メソッドで指定されているように、キャンセルトークンに基づいて通知を非表示またはキャンセルします。

アプリケーションタブ管理 API

アプリケーションタブの状態を作成および管理するには、以下の API を使用します。

メソッド	Description
createTab	フォーカスされたセッションでタブを作成し、作成されたタブの一意の識別子を返します。
getTabs	セッションがチャネルプロバイダーに属している場合、フォーカスされているセッション内のタブのテンプレート名またはテンプレートタグに関連付けられたタブ ID の配列を返します。
focusTab	フォーカスされたセッションがチャネルプロバイダーに属しており、タブがフォーカスされているセッションに属している場合、タブにフォーカスを設定します。
getFocusedTab	セッションがプロバイダーに属している場合、フォーカスされたセッション内のタブの識別子を返します。
refreshTab	タブを更新します。
setTabTitle	フォーカスされたセッションがチャネルプロバイダーに属しており、タブがフォーカスされているセッションに属している場合、タブのタイトルを設定します。
closeTab	現在のセッションで指定されたタブを閉じます。

セッション管理 API

マルチセッションプロバイダー環境でセッションを管理するには、次の API を使用します。

メソッド	Description
canCreateSession	新しいセッションを作成できるかどうかを確認できます。
createSession	テンプレートの一部として定義されたセッションテンプレートに基づいて新しいセッションを作成し、作成されたセッションの一意の識別子を返します。
getSession	セッションがチャネルプロバイダーに属している場合は、セッションの一意の識別子、コンテキスト、および `isFocused` パラメーターの値を含むオブジェクトを返します。
getFocusedSession	セッションがチャネルプロバイダーに属している場合は、フォーカスされているセッションの一意の識別子を返します。それ以外の場合は null を返します。
getAllSessions	チャネルプロバイダーのセッション識別子の配列を返します。
setSessionTitle	セッションがチャネルプロバイダーに属している場合は、セッションのタイトルを設定します。
requestFocusSession	セッションがチャネルプロバイダーに属している場合、セッション識別子がパラメーターとして渡されるセッションにフォーカスを設定します。

チャネル分析 API

イベント分析を追跡するには、次の API を使用します。

メソッド	Description
logAnalyticsEvent	カスタムイベントでこのメソッドを呼び出して、分析を記録します。

セッションインジケーター API

次の API を使用して、主要業績評価指標 (KPI) 違反を示し、特定のセッションの新しい活動の数を更新します。

メソッド	Description
notifyKpiBreach	この方法は、KPI 違反を示すために使用されます。この方法を使用すると、KPI 違反が発生したときに取引先担当者の表示画像に赤い円が表示されます。
notifyNewActivity	このメソッドは、特定のセッション内の新しい活動の数を更新するために使用されます。

プレゼンス API

これらの API を使用して、オムニチャネルエージェントのプレゼンスをプログラムで設定および取得します。これらの方法は、混合エージェントがオムニチャネルを使用して Microsoft 以外のアプリケーションで作業しており、異なるアプリケーション間でプレゼンス状態を同期して、エージェントのキャパシティが最適に利用されるようにする場合に使用できます。

メソッド	Description
setPresence	クライアントセッションでエージェントのプレゼンスをプログラムで設定できるようにします。
getPresence	クライアントセッションでエージェントのプレゼンスをプログラムで返せるようにします。

その他のメソッド

メソッド	Description
getEntityMetadata	指定されたエンティティのエンティティメタデータを返します。
setClickToAct	ブール値を外部通信 (ClickToAct) を有効または無効に設定します。
getClickToAct	ブール値を戻して、外部通信 (ClickToActs) が有効かどうかを示します。
searchAndOpenRecords	メソッドは、内部通信中に通信ウィジェットからレコードを検索し、レコードを開きます。
getEnvironment	最新の統一インターフェイスアプリとページの詳細を取得します。詳細には、アプリケーションID (appid)、pageType (pageType)、レコード ID (id)、組織の地理 (orgGeo)、およびセッションナビゲーションタイプ (navigationType) が含まれます。
openForm	エンティティフォームまたは簡易作成フォームを開きます。
renderSearchPage	特定のエンティティの種類を表すレコード間で検索ができます。この API を使用すると、統一インターフェイスエンティティページが開きます。ページ上の検索フィールドには、パラメーターとして渡した検索文字列があらかじめ入力されています。
addHandler	イベントにサブスクライバーを追加します。注意この API は、ウィジェットと統一インターフェイスページの両方で使用できます。
removeHandler	イベントからサブスクライバーを削除します。注意この API は、ウィジェットと統一インターフェイスページの両方で使用できます。
raiseEvent	イベントに関連付けられたサブスクライバーを呼び出します。注意 addHandler メソッドを使用してカスタムイベントを作成した場合は、このメソッドのパラメータとしてイベント名を渡すことで、それらのイベントを発生させることができます。
updateContext	このメソッドを使用すると、自動辞書を設定できます。
updateConversation	このメソッドでは、会話レコードの更新ができます。

Dynamics 365 チャネル統合フレームワークの新機能
 Dynamics 365 チャネル統合フレームワーク 2.0 のシステム要件

フィードバック

このページはお役に立ちましたか?

Last updated on 2024-12-10