1. Cloud development

文字の特性

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Sitecore Content Hubでは、あらゆる種類のウェブスクリプトは主に2つのオブジェクト、MClientとContextにアクセスできます。 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

コンテキスト特性

コンテキストプロパティとは、スクリプトがアクセス可能な異なるコンテキスト変数のことです。各スクリプトタイプには特定のコンテキストプロパティがあります。以下のセクションでは、各 スクリプトタイプのコンテキストプロパティを定義します。

ユーザーサインインスクリプト

以下の表は 、ユーザーサインイン スクリプトで利用可能なコンテキストプロパティを示しています。

財産

種類

概要

AuthenticationSource

M.Base.Scripting.Users.AuthenticationSource

このプロパティにはユーザーの登録元が含まれており、内部(Content Hub)または外部(外部プロバイダー)である場合があります。 可能な値:

  • Internal
  • External

User

M.Sdk.Contracts.Base.IEntity

このプロパティには、サインインしたユーザーを表すエンティティオブジェクトが含まれています。

ExternalUserInfo

ExternalUserInfo

このプロパティは外部プロバイダーが提供するユーザーに関する情報を含みます。 ExternalUserInfo プロパティ:

  • Provider
  • Username
  • Email
  • Culture
  • Claims

!警告ExternalUserInfoAuthenticationSourceがExternalされた場合にのみ使われます。

ユーザー事前登録スクリプト

以下の表は、User registrationスクリプトで利用可能なコンテキストプロパティを示しています。

財産

種類

概要

AuthenticationSource

M.Base.Scripting.Users.AuthenticationSource

このプロパティにはユーザーの登録元が含まれており、内部(Content Hub)または外部(外部プロバイダー)である場合があります。可能な値:

  • Internal
  • External

Username

string

このプロパティには作成されたユーザーのユーザー名が含まれています。

Email

string

このプロパティには作成されたユーザーのメールアドレスが含まれています。

Culture

System.Globalization.CultureInfo

このプロパティには作成されたユーザーの文化情報が含まれています。

ユーザー登録後スクリプト

以下の表は、User registrationスクリプトで利用可能なコンテキストプロパティを示しています。

財産

種類

概要

AuthenticationSource

M.Base.Scripting.Users.AuthenticationSource

このプロパティにはユーザーの登録元が含まれており、内部(Content Hub)または外部(外部プロバイダー)である場合があります。可能な値:

  • Internal
  • External

User

M.Sdk.Contracts.Base.IEntity

このプロパティには、サインインしたユーザーを表すエンティティオブジェクトが含まれています。

ExternalInfo

ExternalUserInfo

このプロパティは外部プロバイダーが提供するユーザーに関する情報を含みます。 ExternalUserInfo プロパティ:

  • Provider
  • Username
  • Email
  • Culture
  • Claims

!警告ExternalInfoAuthenticationSourceがExternalされた場合にのみ使われます。

メタデータ処理スクリプト

以下の表は、Metadata processingスクリプトで利用可能なコンテキストプロパティを示しています。

財産

種類

概要

File

M.Sdk.Contracts.Processing.IFile

このプロパティには処理中のファイルエンティティが含まれています。 IFile プロパティ:

  • Filename: string
  • Extension: string

Asset

Stylelabs.M.Sdk.Contracts.Base.IEntity

このプロパティには、処理中のファイルエンティティに関連付けられた資産を表すエンティティオブジェクトが含まれています。

MetadataProperties

IReadOnlyDictionary <string, JToken>

このプロパティは利用可能なメタデータを含みます。メタデータのプロパティは処理されたファイルに依存します。

アクションスクリプト

アクションスクリプトの場合、コンテキストプロパティはスクリプトの実行ソースに依存します。実行ソースとはスクリプトを呼び出すメソッドです。コンテキストプロパティは以下のユースケースによって異なります。

  • Web API - スクリプトがWeb API(REST)によって呼び出される場合。この場合、 ExecutionSource は WebApiに等しい。
  • 外部アクション - ページコンポーネントから外部アクションがスクリプトを呼び出す場合。この場合、ExecutionSourceはExternalActionまたはMassEditに等しいです。マス編集メニューからAction scriptを呼び出すと、MassEditに設定されます。
  • トリガー - トリガーのコンテキストプロパティは実行タイプ(In Process または In Background(Out of process))に依存します。
    • バックグラウンド - スクリプトがバックグラウンドのトリガーによって呼び出されたとき。この場合、 ExecutionSource は Trigger 、 ExecutionType は OutOfProcessに等しい。
    • プロセス内 - プロセス内のトリガーによってスクリプトが呼び出される場合。この場合、 ExecutionSource は Trigger 、 ExecutionType は InProcessに等しい。

各ユースケースごとに、タブをクリックすると関連するコンテキストプロパティを含むテーブルが表示されます。

::::タブズ:::tab{title="Web-Api"}

Web API

財産

種類

概要

ExecutionSource

M.Base.Scripting.Action.ExecutionSource

このプロパティはスクリプトの実行元を示します。可能な値:

  • Trigger

  • WebApi

  • ExternalAction

  • MassEdit

実際の価値:

  • WebApi

ExecutionType

M.Base.Scripting.Action.ExecutionType

この性質はスクリプトの実行タイプを示します。可能な値:

  • InProcess

  • OutOfProcess

実際の価値:

  • InProcess

Data

JToken

このプロパティには、Web APIからスクリプトに渡されるPOSTリクエストデータが含まれています。

Result

JToken

このプロパティは、Web APIに返されるスクリプトの出力を含みます。

StatusCode

HttpStatusCode

このプロパティにはWeb APIに戻るステータスコードが含まれています。

対外行動

財産

種類

概要

ExecutionSource

M.Base.Scripting.Action.ExecutionSource

このプロパティはスクリプトの実行元を示します。可能な値:

  • Trigger

  • WebApi

  • ExternalAction

  • MassEdit

実際の価値:

  • ExternalAction
  • MassEdit

ExecutionType

M.Base.Scripting.Action.ExecutionType

この性質はスクリプトの実行タイプを示します。可能な値:

  • InProcess

  • OutOfProcess

実際の価値:

  • OutOfProcess

TargetId

Nullable System.Int64

このプロパティにはスクリプトで処理されるエンティティのIDが含まれています。

TargetType

M.Base.Scripting.Action.TargetType

この性質はスクリプトで処理されるエンティティの種類を示します。可能な値:

  • Entity
  • EntityDefinition
  • Policy
  • DataSource

!注大量編集メニュー(ExecutionSource == MassEdit)からスクリプトが呼び出されると、大量編集アクションに関与するエンティティはスクリプトによって1つずつ処理されます。各反復ごとに、TargetIdは現在処理されているエンティティのIDを含みます。

トリガー

!注Trigger(In Background) のスクリプトプロパティは、Trigger(In Process )と同じで、わずかな違いがあるだけです(例えば、ExecutionPhaseはPOSTで、ExecutionTypeは OutOfProcess.

財産

種類

概要

ExecutionSource

M.Base.Scripting.Action.ExecutionSource

このプロパティはスクリプトの実行元を示します。可能な値:

  • Trigger

  • WebApi

  • ExternalAction

  • MassEdit

実際の価値:

  • Trigger

ExecutionType

M.Base.Scripting.Action.ExecutionType

この性質はスクリプトの実行タイプを示します。可能な値:

  • InProcess

  • OutOfProcess

実際の価値:

  • InProcess

TargetId

Nullable System.Int64

このプロパティにはスクリプトで処理されるエンティティのIDが含まれています。

TargetType

M.Base.Scripting.Action.TargetType

この性質はスクリプトで処理されるエンティティの種類を示します。可能な値:

  • Entity
  • EntityDefinition
  • Policy
  • DataSource

PropertyBag

M.Base.Scripting.Action.IPropertyBag

複数のスクリプトにまたがるユーザー定義プロパティを格納するキー・バリュープロパティバッグです。

Target

System.Object

このプロパティは、トリガーイベントに関連するエンティティを含みます。

ExecutionEvent

M.Base.Scripting.Action.ExecutionEvent

このプロパティはトリガーの実行イベントを示します。可能な値:

  • OnSave
  • OnDelete

ExecutionPhase

M.Base.Scripting.Action.ExecutionPhase

この性質はスクリプトが実行される実行フェーズを示します。可能な値:

  • Pre
  • Validation
  • Security
  • Audit
  • Post

ChangeTracker

IChangeTracker

このプロパティは、エンティティに起こった変化を追跡します。

> [!注]
> ChangeTracker プロパティはポストアクションスクリプトで常に null されています。

!注

  • プロパティバッグはスクリプト全体で利用可能です。各プロパティバッグはイベントや状況の組み合わせに特化しています。

  • 同じトリガーで呼び出されたスクリプトは同じプロパティバッグにアクセスできます。

  • 同じイベント(例

    )および同じ条件(例
    )で複数のトリガーが発動した場合、それらのトリガーのいずれかで呼び出されたスクリプトは同じプロパティバッグにアクセスできます。

:::

この記事を改善するための提案がある場合は、 お知らせください!