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

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.

Fields

Field Field Type Description
Description string Description of the StreamingChannel. Limit: 255 characters.

Field Properties: Create, Filter, Group, Nillable, Sort, Update

Label: Description

ID ID System field: Globally unique string that identifies a StreamingChannel record.

Field Properties: Default on create, Filter, Group, idLookup, Sort

IsDeleted boolean System field: Indicates whether the record has been moved to the Recycle Bin (true) or not (false).

Field Properties: Default on create, Filter, Group, Sort

IsDynamic boolean true if the channel gets dynamically created on subscribe if necessary, false otherwise.

Field Properties: Default on create, Filter, Group, Sort

LastReferencedDate date The timestamp for when the current user last viewed a record related to this record.

Field Properties: Filter, Sort

LastViewedDate date The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.

Field Properties: Filter, Sort

Name string Required. Descriptive name of the StreamingChannel. Limit: 80 characters, alphanumeric and “_”, “/” characters only. Must start with “/u/”. This value identifies the channel and must be unique.

Field Properties: Create, Filter, Group, idLookup, Sort, Update

Label: Streaming Channel Name

OwnerId reference The ID of the owner of the StreamingChannel.

Field Properties: Create, Default on create, Filter, Group, Sort, Update

Label: Owner Name