Newer Version Available
StreamingChannel
Represents a channel that is the basis for notifying listeners of generic Streaming API events. Available from API version 29.0 or later.
Supported Calls
REST: DELETE, GET, PATCH, POST (query requests are specified in the URI)
SOAP: create(), delete(), describe(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update()
Special Access Rules
- This object is available only if Streaming API is enabled for your organization.
- Only users with “Create” permission can create this record. Users with “View All Data” can view StreamingChannel records and see streaming messages.
- You can create a permission set and grant users read and create access to all streaming channels in the org. This access isn’t for a specific channel, like with user sharing.
- You can apply user sharing to StreamingChannel. You can restrict access to receiving or sending events on a channel by sharing channels with specific users or groups. Channels shared with public read-only or read-write access send events only to clients subscribed to the channel that also are using a user session associated with the set of shared users or groups. Only users with read-write access to a shared channel can generate events on the channel, or modify the actual StreamingChannel record.
Dynamic Streaming Channel
Generic Streaming also supports dynamic streaming channel creation, which creates a StreamingChannel when a client first subscribes to the channel. To enable dynamic streaming channels in your org, from Setup, enter User Interface in the Quick Find box, then select User Interface and enable Enable Dynamic Streaming Channel Creation.