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_connect(options = {}) ⇒ Object

  Starts a Real Time Messaging session.

Instance Method Details

#rtm_connect(options = {}) ⇒ Object

Starts a Real Time Messaging session.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :batch_presence_aware (boolean) —

  Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

• :presence_sub (boolean) —

  Only deliver presence events when requested by subscription. See presence subscriptions.

See Also:

• https://api.slack.com/methods/rtm.connect
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/rtm/rtm.connect.json

# File 'lib/slack/web/api/endpoints/rtm.rb', line 18

def rtm_connect(options = {})
  post('rtm.connect', options)
end