この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

RealTimeEventSettings

有効化または無効化するリアルタイムイベントエンティティのリストを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。

ファイルのサフィックスおよびディレクトリの場所

リアルタイムイベント設定は、settings ディレクトリの RealTimeEvent.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。

バージョン

RealTimeEventSettings は、API バージョン 50.0 以降で使用できます。

項目

項目名	項目の型	説明
realTimeEvents	RealTimeEvent[]	有効化または無効化するリアルタイムイベントエンティティのリストを表します。

RealTimeEvent

有効化または無効化するリアルタイムイベントエンティティのいずれかを表します。

項目名	項目の型	説明
entityName	string	変更するストレージまたはストリーミングエンティティ名。例: ApiEvent や ApiEventStream。
isEnabled	boolean	ストレージまたはストリーミング機能を有効化するか (`true`)、無効化するか (`false`) を示します。

宣言的なメタデータの定義のサンプル

RealTimeEvent.settings メタデータファイルの例を次に示します。

1<?xml version=“1.0” encoding=“UTF-8"?>
2<RealTimeEventSettings xmlns=“http://soap.sforce.com/2006/04/metadata”/>
3  <realTimeEvents>
4    <entityName>ApiEventStream</entityName>
5    <isEnabled>true</isEnabled>
6  </realTimeEvents>
7  <realTimeEvents>
8    <entityName>ApiEvent</entityName>
9    <isEnabled>true</isEnabled>
10  </realTimeEvents>
11</RealTimeEventSettings>

RealTimeEventSettings 定義を参照する package.xml マニフェストの例は、次のとおりです。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>RealTimeEvent</members>
5        <name>Settings</name>
6    </types>
7    <version>51.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド