ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

インスタンス設定 YAML 構成リファレンス

インスタンス設定クライアント拡張機能を使用して、さまざまな Liferay 構成を構成できます。各構成は、PID (永続 IDentity) によって参照されます。

client-extension.yaml ファイルを使用して、インスタンス設定クライアント拡張を定義します。

使用法の詳細

この client-extension.yaml ファイルは、インスタンス設定のクライアント拡張を定義します。

yoke-instance-settings:
   type: instanceSettings

YAML プロパティ

これらのプロパティはインスタンス設定クライアント拡張機能に固有です。

名前	データ型	デフォルト値	説明
`description`	文字列		クライアント拡張の説明
`name`	文字列	（派生）	クライアント拡張機能の名前。
`pid`	文字列		構成されたインスタンス設定の PID (永続 IDentity) ( 現在サポートされているインスタンス設定 PIDから)。

追加のプロパティ

インスタンス設定クライアント拡張には、PID (Java クラス) のスキーマによって定義される追加のプロパティが付属しています。

スキーマPIDは、アノテーションプロパティ @Meta.OCD.idで定義されています。

@Meta.OCD(
	id = "com.liferay.foo.FooConfiguration"
)

クライアント拡張定義でこのプロパティを次のように構成します。

yoke-instance-settings:
   pid: com.liferay.foo.FooConfiguration
   type: instanceSettings

以下に、スキーマクラスのプロパティの種類と、それらをクライアント拡張定義に含める方法の例を示します。

スカラープロパティ

以下のスカラースキーマプロパティ定義では、 int (整数) が与えられ、

@Meta.AD(...)
public int invitationTokenExpirationTime();

invitationTokenExpirationTime クライアント拡張プロパティをスカラー YAML プロパティとして設定します。

yoke-instance-settings:
   invitationTokenExpirationTime: 600
   pid: com.liferay.foo.FooConfiguration
   type: instanceSettings

スカラープロパティには次のデータ型が含まれます。

int (整数)
short
long
byte
float (10進数)
double (倍精度10進数)
character
boolean
String

配列プロパティの例

以下の配列スキーマプロパティ定義では、

@Meta.AD(...)
public String[] customTLDs();

customTLDs クライアント拡張プロパティを YAML 配列として設定します。

yoke-instance-settings:
   customTLDs:
      - "foo.net"
      - "*.other.com"
   pid: com.liferay.foo.FooConfiguration
   type: instanceSettings

LocalizedValuesMapプロパティの例

以下の LocalizedValuesMap スキーマプロパティ定義を考えると、

@Meta.AD(...)
public LocalizedValuesMap invitationEmailBody();

invitationEmailBody クライアント拡張プロパティを YAML オブジェクトとして設定します。各オブジェクトキーは特定のロケール文字列です。

yoke-instance-settings:
   invitationEmailBody:
      en_US: |
         <p>
               Follow the link below to set up your account:<br />
               <a href="[$CREATE_ACCOUNT_URL$]">Create Account</a>
               <br />
               <font size="-2">The link will expire after 3 days.</font>
         </p>
   pid: com.liferay.foo.FooConfiguration
   type: instanceSettings