slackline/api/rtm

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Slack Web API methods for the legacy Real Time Messaging API.

Types

Connect

Identifies rtm.connect in the slackline.Call that connect returns.

pub type Connect

RtmConnectResponse

</>

The response from rtm.connect, also returned by rtm.start since September 27, 2022.

pub type RtmConnectResponse {
  RtmConnectResponse(
    url: option.Option(String),
    self: option.Option(RtmSelf),
    team: option.Option(RtmTeam),
  )
}

Constructors

RtmConnectResponse(
  url: option.Option(String),
  self: option.Option(RtmSelf),
  team: option.Option(RtmTeam),
)

Arguments

url: The WebSocket Message Server URL. Valid for 30 seconds.
self: The connecting user.
team: The workspace.

RtmSelf

</>

The connecting user, from rtm.connect.

pub type RtmSelf {
  RtmSelf(id: String, name: option.Option(String))
}

Constructors

RtmSelf(id: String, name: option.Option(String))

Arguments

id: The user ID.
name: The user name.

RtmTeam

</>

Brief information about the workspace, from rtm.connect.

pub type RtmTeam {
  RtmTeam(
    id: String,
    name: option.Option(String),
    domain: option.Option(String),
    enterprise_id: option.Option(String),
    enterprise_name: option.Option(String),
  )
}

Constructors

```
RtmTeam(
  id: String,
  name: option.Option(String),
  domain: option.Option(String),
  enterprise_id: option.Option(String),
  enterprise_name: option.Option(String),
)
```
Arguments

id

The workspace ID.

name

The workspace name.

domain

The workspace domain.

enterprise_id

The Enterprise organization ID, if the workspace is part of one.

enterprise_name

The Enterprise organization name, if the workspace is part of one.

Start

</>

Identifies rtm.start in the slackline.Call that start returns.

pub type Start

Values

connect

</>

pub fn connect() -> slackline.Call(Connect, RtmConnectResponse)

rtm.connect: Starts a Real Time Messaging session.

rtm.Connect identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/rtm/connect.

Rate limit tier: t1.

Documented errors: migration_in_progress.

rtm_connect_response_decoder

</>

pub fn rtm_connect_response_decoder() -> decode.Decoder(
  RtmConnectResponse,
)

Decodes RtmConnectResponse from json.

rtm_connect_response_to_json

</>

pub fn rtm_connect_response_to_json(
  it: RtmConnectResponse,
) -> json.Json

Encodes RtmConnectResponse as json.

rtm_self_decoder

</>

pub fn rtm_self_decoder() -> decode.Decoder(RtmSelf)

Decodes RtmSelf from json.

rtm_self_to_json

</>

pub fn rtm_self_to_json(it: RtmSelf) -> json.Json

Encodes RtmSelf as json.

rtm_team_decoder

</>

pub fn rtm_team_decoder() -> decode.Decoder(RtmTeam)

Decodes RtmTeam from json.

rtm_team_to_json

</>

pub fn rtm_team_to_json(it: RtmTeam) -> json.Json

Encodes RtmTeam as json.

start

</>

pub fn start() -> slackline.Call(Start, RtmConnectResponse)

Deprecated: Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.

rtm.start: Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.

rtm.Start identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/rtm/start.

Rate limit tier: t1.

Documented errors: migration_in_progress, rtm_connect_required.