Module: Slack::Web::Api::Endpoints::Rtm

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/rtm.rb

Instance Method Summary

• #rtm_start(options = {}) ⇒ Object

  This method starts a Real Time Messaging API session.

Instance Method Details

#rtm_start(options = {}) ⇒ Object

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.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :simple_latest (Object) —

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

• :no_unreads (Object) —

  Skip unread counts for each channel (improves performance).

• :mpim_aware (Object) —

  Returns MPIMs to the client in the API response.

See Also:

• https://api.slack.com/methods/rtm.start
• https://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