Force.com Streaming API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Create a Streaming Channel

Create a new StreamingChannel object by using the Salesforce UI.

You must have the proper Streaming API permissions enabled in your organization.

  1. Log into your Developer Edition organization. Under All Tabs (+) select Streaming Channels.
  2. On the Streaming Channels tab, select New to create a new Streaming Channel.
  3. Enter /u/notifications/ExampleUserChannel in Streaming Channel Name, and an optional description. Your new Streaming Channel page should look something like this:Screenshot of a new streaming channel
  4. Select Save. You’ve just created a new Streaming Channel that clients can subscribe to for notifications.

StreamingChannel is a regular, createable Salesforce object, so you can also create one programmatically using Apex or any data API like SOAP API or REST API.

Also, if you need to restrict which users can receive or send event notifications, you can use user sharing on the StreamingChannel to control this. Channels shared with public read only or read-write access will only send events 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. To modify user sharing for a StreamingChannel, from Setup, go to Security Controls | Sharing Settings and create or modify a StreamingChannel sharing rule.

Generic Streaming also supports dynamic streaming channel creation. With dynamic streaming channel creation, a StreamingChannel will be automatically created when a client first subscribes to the channel. To enable dynamic streaming channels in your organization, from Setup, go to Customize | User Interface and enable Enable Dynamic Streaming Channel Creation.