Class: Streaming

Streaming

new Streaming(conn)

Streaming API class
Parameters:
Name Type Description
conn Connection Connection object
Source:

Extends

  • events.EventEmitter

Classes

Channel
Topic

Methods

channel(channelId) → {Streaming~Channel}

Get Channel for Id
Parameters:
Name Type Description
channelId String Id of StreamingChannel object
Source:
Returns:
Type
Streaming~Channel

subscribe(name, listener) → {Subscription}

Subscribe topic/channel
Parameters:
Name Type Description
name String Topic name
listener Callback.<Streaming~StreamingMessage> Streaming message listener
Source:
Returns:
- Faye subscription object
Type
Subscription

topic(name) → {Streaming~Topic}

Get named topic
Parameters:
Name Type Description
name String Topic name
Source:
Returns:
Type
Streaming~Topic

unsubscribe(name, listener) → {Streaming}

Unsubscribe topic
Parameters:
Name Type Description
name String Topic name
listener Callback.<Streaming~StreamingMessage> Streaming message listener
Source:
Returns:
Type
Streaming

Type Definitions

StreamingMessage

Type:
  • Object
Properties:
Name Type Description
event Object
Properties
Name Type Description
type Object Event type
sobject Record Record information
Source: