メタデータ API 開発者ガイド
jNotificationTypeConfig
ファイルのサフィックスおよびディレクトリの場所
NotificationTypeConfig コンポーネントのサフィックスは .config で、notificationTypeConfig フォルダに保存されます。
バージョン
NotificationTypeConfig コンポーネントは、API バージョン 48.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| notificationTypeSettings | NotificationTypeSettings[] | 組織の通知種別に対する配信設定の配列。 |
NotificationTypeSettings
標準またはカスタム通知種別に関連付けられた配信設定を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| notificationType | string |
必須。通知種別の API 名を指定します。 標準通知種別の場合、これには標準通知種別の事前定義 API 名を指定します。カスタム通知種別の場合、これにはカスタム通知種別の API 名を指定します。カスタム通知種別が管理パッケージと共にインストールされている場合、その名前空間のプレフィックスを含めます。 組織で利用できる通知種別の API 名を確認するには、NotificationTypeConfig を取得します。 |
| appSettings | AppSettings[] | 特定の通知種別をサポートする接続アプリケーションの設定の配列。 |
| notificationChannels | NotificationChannels | 通知種別の配信チャネルを定義します。 |
AppSettings
通知種別でサポートされる接続アプリケーションの設定を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| connectedAppName | string | 必須。接続アプリケーションの API 名を指定します。接続アプリケーションが管理パッケージと共にインストールされている場合、API 名に名前空間のプレフィックスを含めます。 通知種別に対してサポートされる接続アプリケーションの API 名を確認するには、NotificationTypeConfig を取得します。 |
| enabled | boolean | 接続アプリケーションが有効化されているか (true)、否か (false) を示します。 |
NotificationChannels
特定の通知種別に対する配信チャネルの設定を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| desktopEnabled | boolean | デスクトップ通知が有効化されているか (true)、否か (false) を示します。 |
| mobileEnabled | boolean | モバイル通知が有効化されているか (true)、否か (false) を示します。 |
宣言的なメタデータの定義のサンプル
NotificationTypeConfig コンポーネントの例を次に示します。
組織で使用可能なすべての通知設定を取得するために使用される、パッケージマニフェストの例を次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。