Microsoft.CIFramework メソッド (Dynamics 365 チャネル統合フレームワーク 1.0 JavaScript API リファレンスの )
Microsoft CIFramework は、JavaScript API を使用して、Dynamics 365 モデル駆動型アプリの通信パネル、レコード、およびフォームを管理するメソッドを提供します。
重要
- 他の API を呼び出す前に、 CIFInitDoneイベント ハンドラ を呼び出す必要があります。
- API のタイムアウト制限は 10 秒です。 API が 10 秒以内に実行されない場合は、パラメーターまたはスコープを変更して再度実行する必要があります。
通信のパネル管理の API
通信パネルは、エージェントとして顧客と対話する場です。 Channel Integration Framework 1.0 を使用して構築されたパートナー ウィジェットは、このパネルにロードされます。 このバージョンのウィジェットは画面の右側に表示され、ドッキング、最小化モードをサポートします。
コミュニケーション パネル (ウィジェット) の状態を管理するには、以下の API を使用します。
| メソッド | Description |
|---|---|
| setWidth | すべてのセッションのパネル幅を設定します。 |
| getWidth | パネルの幅をピクセル単位で取得します。 |
| setMode | パネルの状態を設定します。 |
| getMode | パネルの状態を設定します。 |
CRUD 操作 API
エンティティ レコードに対して CRUD オペレーションを実行するには、次の API を使用します。
| メソッド | Description |
|---|---|
| createRecord | エンティティ レコードを作成します。 |
| retrieveRecord | エンティティ レコードを取得します。 |
| updateRecord | エンティティ レコードを更新します。 |
| deleteRecord | エンティティ レコードを削除します。 |
その他のメソッド
| メソッド | 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 | このメソッドを使用すると、自動辞書を設定できます。 |
参照
Dynamics 365 チャネル統合 フレームワークの新機能
Dynamics 365 Channel Integration Framework 1.0 のシステム要件