new Streaming(conn)
Streaming API class
Parameters:
Name | Type | Description |
---|---|---|
conn |
Connection | Connection object |
- Source:
Extends
- events.EventEmitter
Classes
Methods
-
subscribe(name, listener) → {Streaming}
-
Subscribe topic
Parameters:
Name Type Description name
String Topic name listener
Callback.<Streaming~StreamingMessage> Streaming message listener - Source:
Returns:
- Type
- Streaming
-
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
- Source:
Properties:
Name Type Description event
Object Properties
Name Type Description type
Object Event type sobject
Record Record information