モデル駆動型アプリのクライアント API Xrm オブジェクト

実行コンテキストなしで、コードでクライアント API Xrm オブジェクトを使用できます。 その名前空間を使用して、フォームを操作し、Web API でレコードを管理し、デバイス機能を使用し、モデル駆動型アプリでグローバル コンテキストを取得します。

Xrmオブジェクト モデル

次の図はXrmオブジェクト モデルを表しています:

名前空間を示すクライアント API Xrm オブジェクト モデルのスクリーンショット。

Xrmオブジェクトの各ネームスペースについての情報はこちら:

Namespace 説明
Xrm.App アプリ関連のメソッドを提供します。
Xrm.Copilot 登録されたMicrosoft Copilot Studioトピックを実行するためのプレビュー API など、モデル駆動型Power AppsでMicrosoft Copilotを操作するためのメソッドを提供します。
Xrm.Device ネイティブ デバイス機能を使用するメソッドを提供します。
Xrm.Encoding 文字列をエンコードするためのメソッドを提供します。
Xrm.Navigation モデル駆動型アプリのフォームおよびアイテム間を移動するためのメソッドを提供します。
Xrm.Panel モデル駆動型アプリ フォームのサイド ウインドウで Web ページを表示するメソッドを提供します。
Xrm.Utility 有用なメソッドのコンテナを提供します。
Xrm.WebApi Web API を使用してレコードを作成および管理し、Web API アクションおよび関数を実行するメソッドを提供します。

Xrm.WebApi.offline: オフライン モードを使用中にモデル駆動型アプリ モバイル クライアントのレコードを作成および管理するメソッドを提供します。

Xrm.WebApi.online: サーバーに接続しているときに、Web API を使用してレコードを作成および管理し、Web API アクションおよび関数を実行するメソッドを提供します。

クライアントAPIグローバルコンテキスト

フォームでは、Xrm.Utility.getGlobalContext メソッドを使用して、フォーム実行コンテキストを経由せずに、スクリプトが実行される組織、ユーザー、またはクライアントに固有の情報を取得します。 getGlobalContext の使用は、Xrm.Page.context を使用してグローバルコンテキストを取得するために、フォームコンテキストを使用する必要があった以前のバージョンからの変更です。

注

Xrm.Page.context は現在のリリースで 非推奨 となっており、バージョン 9.0 以降を対象とするコードでグローバル コンテキストを取得するには、新しい Xrm.Utility.getGlobalContext メソッドを使用する必要があります。

スタンドアロン HTML Web リソースのグローバル コンテキスト情報にアクセスするには、Web リソースに ClientGlobalContext.js.aspx への参照を含め、 GetGlobalContext 関数を使用します。 詳細については、「 GetGlobalContext 関数と ClientGlobalContext.js.aspx」を参照してください。

クライアント API オブジェクト モデルを理解する
廃止されたクライアント API