Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

RealTimeEventSettings

Represents the list of Real-Time Event entities that you want to enable or disable. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

File Suffix and Directory Location

Real-Time Event settings are stored in a single file named RealTimeEvent.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

RealTimeEventSettings is available in API version 50.0 and later.

Fields

Field Name	Field Type	Description
realTimeEvents	RealTimeEvent[]	Represents the list of Real-Time Event entities that you want to enable or disable.

RealTimeEvent

Represents one of the Real-Time Event entities that you want to enable or disable.

Field Name	Field Type	Description
entityName	string	The storage or streaming entity name that you want to modify. For example: ApiEvent or ApiEventStream.
isEnabled	boolean	Indicates whether you want the storage or streaming capability to be enabled (`true`) or disabled (`false`).

Declarative Metadata Sample Definition

The following is an example RealTimeEvent.settings metadata file:

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>

The following is an example package.xml manifest that references the RealTimeEventSettings definitions:

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>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide