スクリプトのプロパティ
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore Content Hubでは、すべてのタイプのスクリプトが、MClientとContextの2つの主要なオブジェクトにアクセスできます。 MClientオブジェクトとContextオブジェクトはどちらも、便利なプロパティのコレクションをユーザーに提供します。詳細については、APIリファレンス を参照してください。
MClientプロパティ
MClientプロパティは、すべてのタイプのスクリプトで使用できます。これにより、ユーザーはContent Hub内のデータ (データ ソース、エンティティ、エンティティ定義、ポリシー、スクリプト、ユーザーなど) や、さまざまなクライアントを介したクエリやログ記録などのその他の機能を操作できます。
次の表は、使用可能なMClientプロパティをまとめたものです。
|
財産 |
種類 |
|---|---|
|
Commands |
Stylelabs.M.Sdk.Clients.ICommandsClient |
|
Cultures |
Stylelabs.M.Sdk.Clients.ICultureClient |
|
DataSourceFactory |
Stylelabs.M.Sdk.Factories.IDataSourceFactory |
|
DataSources |
Stylelabs.M.Sdk.Clients.IDataSourcesClient |
|
Entities |
Stylelabs.M.Sdk.Clients.IEntitiesClient |
|
EntityDefinitions |
Stylelabs.M.Sdk.Clients.IEntityDefinitionsClient |
|
EntityFactory |
Stylelabs.M.Sdk.Factories.IEntityFactory |
|
Jobs |
Stylelabs.M.Sdk.Clients.IJobsclient |
|
Logger |
Stylelabs.M.Sdk.Contracts.Logging.ILogger |
|
Notifications |
Stylelabs.M.Sdk.Clients.INotificationsClient |
|
Package |
Stylelabs.M.Sdk.Clients.IPackageClient |
|
Policies |
Stylelabs.M.Sdk.Clients.IPoliciesClient |
|
Querying |
Stylelabs.M.Sdk.Clients.IQueryingClient |
|
Scripts |
Stylelabs.M.Sdk.Clients.IScriptsClient |
|
Settings |
Stylelabs.M.Sdk.Clients.ISettingsClient |
|
TypedEntityFactory |
Stylelabs.M.Sdk.Factories.ITypedEntityFactory |
|
Users |
Stylelabs.M.Sdk.Clients.IUsersClient |
コンテキストプロパティ
コンテキストプロパティは、スクリプトからアクセスできるさまざまなコンテキスト変数です。各スクリプトタイプには、特定のコンテキストプロパティがあります。次のセクションでは、各スクリプトタイプのコンテキストプロパティを定義します。
ユーザー サインイン スクリプト
次の表に、User sign-inスクリプトで使用できるコンテキスト プロパティを示します。
|
財産 |
種類 |
形容 |
|---|---|---|
|
AuthenticationSource |
M.Base.Scripting.Users.AuthenticationSource |
このプロパティには、ユーザーの登録ソースが含まれており、内部 (Content Hub) または外部 (外部プロバイダー) の場合があります。 Possible values:
|
|
User |
M.Sdk.Contracts.Base.IEntity |
このプロパティには、サインインしているユーザーを表すエンティティ オブジェクトが含まれています。 |
|
ExternalUserInfo |
ExternalUserInfo |
このプロパティには、外部プロバイダーが提供するユーザーに関する情報が含まれています。 ExternalUserInfoプロパティ:
|
ExternalUserInfoは、AuthenticationSourceがExternalの場合にのみ使用されます。
ユーザー事前登録スクリプト
次の表に、User registrationスクリプトで使用できるコンテキスト プロパティを示します。
|
財産 |
種類 |
形容 |
|---|---|---|
|
AuthenticationSource |
M.Base.Scripting.Users.AuthenticationSource |
このプロパティには、ユーザーの登録ソースが含まれており、内部 (Content Hub) または外部 (外部プロバイダー) の場合があります。可能な値:
|
|
Username |
string |
このプロパティには、作成されたユーザーのユーザー名が含まれます。 |
|
|
string |
このプロパティには、作成されたユーザーの電子メールが含まれます。 |
|
Culture |
System.Globalization.CultureInfo |
このプロパティには、作成されたユーザーのカルチャ情報が含まれています。 |
ユーザー登録後スクリプト
次の表に、User registrationスクリプトで使用できるコンテキスト プロパティを示します。
|
財産 |
種類 |
形容 |
|---|---|---|
|
AuthenticationSource |
M.Base.Scripting.Users.AuthenticationSource |
このプロパティには、ユーザーの登録ソースが含まれており、内部 (Content Hub) または外部 (外部プロバイダー) の場合があります。可能な値:
|
|
User |
M.Sdk.Contracts.Base.IEntity |
このプロパティには、サインインしているユーザーを表すエンティティ オブジェクトが含まれています。 |
|
ExternalInfo |
ExternalUserInfo |
このプロパティには、外部プロバイダーが提供するユーザーに関する情報が含まれています。 ExternalUserInfoプロパティ:
|
ExternalInfoは、AuthenticationSourceがExternalの場合にのみ使用されます。
メタデータ処理スクリプト
次の表に、Metadata processingスクリプトで使用できるコンテキスト プロパティを示します。
|
財産 |
種類 |
形容 |
|---|---|---|
|
File |
M.Sdk.Contracts.Processing.IFile |
このプロパティには、処理中のFileエンティティが含まれます。 IFileプロパティ:
|
|
Asset |
Stylelabs.M.Sdk.Contracts.Base.IEntity |
このプロパティには、処理中のFileエンティティに関連付けられたアセットを表すエンティティオブジェクトが含まれます。 |
|
MetadataProperties |
IReadOnlyDictionary <string, JToken> |
このプロパティには、使用可能なメタデータが含まれています。メタデータのプロパティは、処理されたファイルによって異なります。 |
アクションスクリプト
Action scriptsの場合、コンテキストプロパティはスクリプトの実行ソースによって異なります。実行ソースは、スクリプトが呼び出されるメソッドです。コンテキストプロパティは、次のユースケースによって異なります。
-
Web Api - スクリプトがWeb API (REST) によって呼び出される場合。この場合、ExecutionSourceはWebApiに等しくなります。
-
External Action- スクリプトがページコンポーネントからの外部アクションによって呼び出されたとき。この場合、ExecutionSourceはExternalActionまたはMassEditに等しくなります。一括編集メニューからAction scriptが呼び出されたときにMassEditに設定されます。
-
Triggers - トリガーのコンテキスト プロパティは、実行タイプ (インプロセス または バックグラウンド (アウト オブ プロセス) ) によって異なります。
-
In Background - スクリプトがバックグラウンドのトリガーによって呼び出されたとき。この場合、ExecutionSourceはTriggerに等しく、ExecutionTypeはOutOfProcessに等しくなります。
-
In Process - スクリプトが進行中のトリガーによって呼び出されたとき。この場合、ExecutionSourceはTriggerに等しく、ExecutionTypeはInProcessに等しくなります。
-
ユースケースごとに、タブをクリックすると、関連するコンテキストプロパティを含むテーブルが表示されます。