クライアント側コンテキスト(クライアント側の参照)

 

公開日: 2017年1月

対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online

コードは、複数の変数が設計中に不明なコンテキストで実行する必要があります。 コンテキスト オブジェクトは、ページに渡された組織、ユーザー、またはパラメーターに固有の情報を取得するためのメソッドを提供します。

コンテキストオブジェクトは、Xrm.Page.contextを参照することで、フォームで使用できます。

フォームの外で実行される Web リソースについては、GetGlobalContext 関数 を使用して、コンテキストオブジェクトを取得します。

コンテキストのプロパティとメソッド

  • クライアント
    使用可能な getClient、getClientState、および getFormFactor メソッドへのアクセスを提供して、使用されているクライアント、クライアントがサーバーに接続されているかどうか、使用されているデバイスの種類を決定します。

  • getClientUrl
    アプリケーションへのアクセスに使用された基本 URL を返します。

  • getCurrentTheme
    ユーザーによって選択された現在の Microsoft Office Outlook テーマを表す文字列を返します。

  • getIsAutoSaveEnabled
    自動保存を組織で有効にするかどうかを返します。

  • getOrgLcid
    組織の基本言語を表す言語コードの識別子 (LCID) の値を返します。

  • getOrgUniqueName
    組織名の一意のテキスト値を返します。

  • getQueryStringParameters
    このページに渡されたクエリ文字列引数を表すキー値をペアのディクショナリ オブジェクトを返します。

  • getTimeZoneOffsetMinutes
    ローカル時間と標準の協定世界時 (UTC) との時差を返します。

    このメソッドは、Microsoft Dynamics CRM Online 2015 更新プログラム 1 で導入されました。

  • getUserId
    現在のユーザーの SystemUser.Id 値の GUID を返します。

  • getUserLcid
    ユーザーが優先する言語として選択したプロビジョニングされた言語を表す LCID 値を返します。

  • getUserName
    現在のユーザー名を返します。

  • getUserRoles
    ユーザーが関連付けられているセキュリティ ロール、またはユーザーが割り当てられているチームのそれぞれの GUID 値を表す文字列の配列を返します。

  • getVersion
    Dynamics 365 サーバーのバージョン番号を返します。

  • prependOrgName
    組織名を指定したパスの前に追加します。

  • 削除されたメソッド
    削除されたメソッドは、使用されなくなるか他のメソッドと取り替えられます。 これらのメソッドはスクリプトで使用されないことを確認してください。

    getAuthenticationHeader および getServerUrl メソッドは Microsoft Dynamics CRM 2011 で削除され、Microsoft Dynamics 365 (オンラインおよび設置型)にはもうありません。

    isOutlookClient および isOutlookOnline メソッドは Microsoft Dynamics CRM 2013 で削除され、Microsoft Dynamics 365 (オンラインおよび設置型)にはもうありません。

クライアント

Microsoft Dynamics CRM 2013 および Microsoft Dynamics CRM Online では、クライアントについての情報を取得するための、getClient および getClientState メソッドを含むクライアント オブジェクトが追加されました。

Microsoft Dynamics CRM Online 2015 更新プログラム 1 に getFormFactor メソッドを追加しました。

getClient

どのクライアントでスクリプトを実行するかを示す値を返します。

context.client.getClient()

削除された isOutlookClient メソッドの代わりにこれを使用します。

  • 戻り値
    種類: 文字列

    返される値は次のとおりです。

    クライアント

    Web

    ブラウザー

    Outlook

    Outlook

    携帯電話

    携帯電話

    携帯電話

    対話型サービス ハブ

getClientState

削除された isOutlookOnline メソッドの代わりにこれを使用します。

クライアントの状態を示す値を返します。

context.client.getClientState()
  • 戻り値
    種類: 文字列

    返される可能性のある値は次のとおりです。

    クライアント

    オンライン

    Web、Outlook、Mobile、対話型サービス ハブ

    オフライン

    Outlook、モバイル

getFormFactor

このメソッドを使用して、ユーザーが使用しているデバイスの種類に関する情報を取得します。

context.client.getFormFactor()
  • 戻り値
    種類: 数値

    返される可能性のある値は次のとおりです。

    フォーム ファクター

    0

    不明

    1

    デスクトップ

    2

    タブレット PC

    3

    電話番号

  • 備考
    このメソッドは、Microsoft Dynamics CRM Online 2015 更新プログラム 1 で導入されました。

getClientUrl

アプリケーションへのアクセスに使用された基本 URL を返します。

context.getClientUrl()

削除された getServerUrl メソッドの代わりにこれを使用します。

返された値は、次の表に示されているようなものになります。

クライアント

http(s)://server/org

Dynamics 365 (設置型)

https://org.crm.dynamics.com

Microsoft Dynamics 365 (オンライン)

http://localhost:2525

オフライン アクセス対応 Outlook 用 Microsoft Dynamics 365 オフラインのとき

  • 戻り値
    種類: 文字列

getCurrentTheme

ユーザーによって選択された現在の Microsoft Office Outlook テーマを表す文字列を返します。

注意

この関数は Dynamics 365 モバイル クライアント (電話やタブレット) および対話型サービス ハブでサポートされていません。

context.getCurrentTheme()
  • 戻り値
    種類: 文字列

この情報を使用して、Outlook 用 Microsoft Dynamics 365 で表示される際 HTML および Silverlight Web リソースに適切なテーマを選択します。 次の表は、このメソッドから返される可能性のある値の一覧を示します。

注意

フォームは、Microsoft Office テーマの変更を採用しないので、Microsoft Office テーマに採用できるのは、HTML Web リソースを使用してナビゲーションにページが表示される時です。 このシナリオでも、ビジュアルの違いはあまり分かりません。

テーマ

既定値

Microsoft Dynamics 365Web アプリケーション

Office12Blue

Outlook 用 Microsoft Dynamics 3652007 または 2010 青のテーマ

Office14Silver

Outlook 用 Microsoft Dynamics 365 2007 または 2010 銀色または黒のテーマ

getIsAutoSaveEnabled

このメソッドは、Microsoft Dynamics CRM 2015 および Microsoft Dynamics CRM Online 2015 更新プログラム で導入されました。

自動保存を組織で有効にするかどうかを返します。

context.getIsAutoSaveEnabled()
  • 戻り値
    種類: ブール値

    注意

    この関数は、ページが開いたとき、値セットを返します。 この値を使用してコードをテストした場合は、値を変更した後に、新しい値を取得するのにはページを更新する必要があります。

    詳細:TechNet: オートセーブを管理

getOrgLcid

組織の基本言語を表すLCID値を返します。

context.getOrgLcid()

getOrgUniqueName

組織名の一意のテキスト値を返します。

context.getOrgUniqueName()
  • 戻り値
    種類: 文字列

    例: これは組織名値に対応しています。

    "adventureworkscycle"
    

getQueryStringParameters

このページに渡されたクエリ文字列引数を表すキー値をペアのディクショナリ オブジェクトを返します。

context.getQueryStringParameters()
  • 戻り値
    種類: オブジェクト

getTimeZoneOffsetMinutes

ローカル時間と標準の協定世界時 (UTC) との時差を返します。

注意

このメソッドは、Microsoft Dynamics CRM Online 2015 更新プログラム 1 で導入されました。

context.getTimeZoneOffsetMinutes()
  • 戻り値
    種類: 数値

getUserId

現在のユーザーの SystemUser.Id 値の GUID を返します。

context.getUserId()
  • 戻り値
    種類: 文字列

    例:

    "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"
    

getUserLcid

ユーザーが優先する言語として選択したMicrosoft Dynamics 365言語パックを表す LCID 値を返します。

context.getUserLcid()

getUserName

現在のユーザー名を返します。

context.getUserName()
  • 戻り値
    種類: 文字列

getUserRoles

ユーザーが関連付けられているセキュリティ ロール、またはユーザーが割り当てられているチームのそれぞれの GUID 値を表す文字列の配列を返します。

セキュリティ ロールの詳細については、「ロールベースのセキュリティを使用して Microsoft Dynamics 365 におけるエンティティへのアクセスを制御する方法 」を参照してください。

context.getUserRoles()
  • 戻り値
    種類: 配列

    例: このユーザーには、ユーザー アカウントに関連付けられたセキュリティ ロールのみがあります。 単一の値を持つこの配列の JSON表現は、次のとおりです:

    ["cf4cc7ce-5d51-df11-97e0-00155db232d0"]
    

getVersion

Dynamics 365 サーバーのバージョン番号を返します。

context.getVersion()
  • 戻り値
    種類: 文字列

prependOrgName

組織名を指定したパスの前に追加します。

context.prependOrgName(sPath)
  • 引数
    種類: 文字列

    リソースへのローカル パス。

  • 戻り値
    種類: 文字列

    返された値は、このパターンに従います。

    "/"+ OrgName + sPath
    

削除されたメソッド

削除されたメソッドは、使用されなくなるか他のメソッドと取り替えられます。 これらのメソッドはスクリプトで使用されないことを確認してください。

次のメソッドは、以前のバージョンのMicrosoft Dynamics 365 で削除され、現在のバージョンにはありません。

  • getAuthenticationHeader
    このメソッドは、Microsoft Dynamics CRM 4.0 Web サービス の使用をサポートしていましたが、現在はなくなりました。

  • getServerUrl
    このメソッドは、getClientUrlによって置き換えられました。

  • isOutlookClient
    このメソッドは、クライアント.getClient に置き換えられました。

  • isOutlookOnline
    このメソッドは、クライアント.getClientState に置き換えられました。

関連項目

GetGlobalContext 関数および ClientGlobalContext.js.aspx (クライアント側の参照)
フォーム スクリプトの簡易参照
Microsoft Dynamics 365 フォームのコードを記述する
Xrm.Page オブジェクト モデルの使用
クライアント側のプログラミング リファレンス

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. 著作権