RealTimeEventSettings

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

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

This type extends Metadata and inherits its fields.

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.

Introduced in API version 50.0.

• Type: RealTimeEvent[]
• Required: No
• Description: Represents the list of Real-Time Event entities that you want to enable or disable.

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

• Type: string
• Required: Yes
• Description: The storage or streaming entity name that you want to modify. For example: ApiEvent or ApiEventStream.

• Type: boolean
• Required: Yes
• Description: Indicates whether you want the storage or streaming capability to be enabled (true) or disabled (false).

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>

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.