SlackWebAPI v1.2.0 SlackWebAPI.Api.Rtm View Source

API calls for all endpoints tagged Rtm.

Link to this section Summary

Functions

Starts a Real Time Messaging session.

Link to this section Functions

Link to this function

rtm_connect(connection, opts \\ [])

View Source
rtm_connect(Tesla.Env.client(), keyword()) ::
  {:ok, map()} | {:error, Tesla.Env.t()}

Starts a Real Time Messaging session.

Parameters

  • connection (SlackWebAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :presence_sub (boolean()): Only deliver presence events when requested by subscription. See presence subscriptions.
    • :token (String.t): Authentication token. Requires scope: rtm:stream
    • :batch_presence_aware (boolean()): Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

Returns

{:ok, %{}} on success {:error, info} on failure