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

通知タイプ YAML 構成リファレンス

client-extension.yaml ファイルを使用して、通知タイプのクライアント拡張機能を定義できます。

使用法の詳細

この client-extension.yaml ファイルは、通知タイプと OAuth ユーザーエージェントを定義します。

zebra-notification-type:
    oAuth2ApplicationExternalReferenceCode: zebra-oauth-user-agent
    resourcePath: /zebra/notification
    type: notificationType

zebra-oauth-user-agent:
    type: oAuthApplicationUserAgent

必須の resourcePath プロパティは、通知ハンドラーの場所を定義します。外部アプリケーションとしてアクセス可能な通知ハンドラーの実装をポイントします。この値は、OAuth2 アプリケーションプロファイルの homePageURL 値と組み合わされて、完全な URL を形成します。

通知タイプのクライアント拡張機能では、Liferay の通知によってトリガーされるリクエストを保護するために OAuth2 アプリケーションプロファイルが必要です。上記の例では、このプロファイルに対して追加の OAuth ユーザーエージェントクライアント拡張を定義し、 oAuth2ApplicationExternalReferenceCode プロパティがその キー 値を参照します。

サンプルワークスペースは、通知タイプのクライアント拡張機能の追加を示しています。

YAML プロパティ

これらのプロパティは、通知タイプのクライアント拡張に固有です。

名前	データ型	説明
`resourcePath`	文字列（URLの一部）	(必須) 通知ハンドラーへのパス。この値は、OAauth2アプリケーションプロファイルの `homePageURL` の値と組み合わされて、完全なURLとなります。
`oAuth2ApplicationExternalReferenceCode`	文字列	(必須) リクエストを保護するために必要な、OAuth2アプリケーションプロファイルの外部参照コード。