RtmFacet

Kind: global class

• RtmFacet
  • .start(opts, optCb)
  • .connect(opts, optCb)

rtmFacet.start(opts, optCb)

Starts a Real Time Messaging session.

Kind: instance method of [RtmFacet](#RtmFacet)
See: rtm.start

Param	Type	Description
opts	Object
opts.simple_latest	Boolean	Return timestamp only for latest message object of each channel (improves performance).
opts.no_unreads	Boolean	Skip unread counts for each channel (improves performance).
opts.mpim_aware	Boolean	Returns MPIMs to the client in the API response.
opts.presence_sub	Boolean	Support presence subscriptions on this socket connection.
opts.include_locale	Boolean	Set this to true to receive the locale for users and channels. Defaults to false
optCb	function	Optional callback, if not using promises.

rtmFacet.connect(opts, optCb)

Starts a Real Time Messaging session using the lighter-weight rtm.connect. This will give us a WebSocket URL without the payload of rtm.start.

Kind: instance method of [RtmFacet](#RtmFacet)
See: rtm.connect

Param	Type	Description
opts	Object
opts.presence_sub	Boolean	Support presence subscriptions on this socket connection.
optCb	function	Optional callback, if not using promises.