module Slack::Web::Api::Endpoints::Rtm

Public Instance Methods

rtm_start(options = {}) click to toggle source

This method starts a Real Time Messaging API session. Refer to the RTM API documentation for full details on how to use the RTM API.

@option options [Object] :simple_latest

Return timestamp only for latest message object of each channel (improves performance).

@option options [Object] :no_unreads

Skip unread counts for each channel (improves performance).

@option options [Object] :mpim_aware

Returns MPIMs to the client in the API response.

@see api.slack.com/methods/rtm.start @see github.com/dblock/slack-api-ref/blob/master/methods/rtm.start.json

# File lib/slack/web/api/endpoints/rtm.rb, line 20
def rtm_start(options = {})
  post('rtm.start', options)
end