Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
RealTimeEventSettings
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:
<?xml version=“1.0” encoding=“UTF-8"?>
<RealTimeEventSettings xmlns=“http://soap.sforce.com/2006/04/metadata”/>
<realTimeEvents>
<entityName>ApiEventStream</entityName>
<isEnabled>true</isEnabled>
</realTimeEvents>
<realTimeEvents>
<entityName>ApiEvent</entityName>
<isEnabled>true</isEnabled>
</realTimeEvents>
</RealTimeEventSettings>The following is an example package.xml manifest that references the RealTimeEventSettings definitions:
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>RealTimeEvent</members>
<name>Settings</name>
</types>
<version>51.0</version>
</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.