ready

Types

CallVoiceState

A voice state in a conversation’s call: it has no room.

pub type CallVoiceState {
  CallVoiceState(
    user_id: String,
    muted: Bool,
    deafened: Bool,
    screen_sharing: Bool,
    camera: Bool,
    version: Int,
  )
}

Constructors

CallVoiceState(
  user_id: String,
  muted: Bool,
  deafened: Bool,
  screen_sharing: Bool,
  camera: Bool,
  version: Int,
)

Arguments

camera: Their camera is on.

GatewayReadyActiveCall

</>

pub type GatewayReadyActiveCall {
  GatewayReadyActiveCall(
    conversation_id: String,
    initiator_id: String,
    initiator_name: option.Option(String),
    initiator_avatar: option.Option(String),
    voice_states: option.Option(List(CallVoiceState)),
    ringing: option.Option(Bool),
    answered: option.Option(Bool),
  )
}

Constructors

GatewayReadyActiveCall(
  conversation_id: String,
  initiator_id: String,
  initiator_name: option.Option(String),
  initiator_avatar: option.Option(String),
  voice_states: option.Option(List(CallVoiceState)),
  ringing: option.Option(Bool),
  answered: option.Option(Bool),
)

Arguments

initiator_name: The caller’s name and avatar, as CALL_INCOMING carries them.
ringing: Whether the call still rings for this user. None from a gateway that doesn’t say.
answered: Whether someone other than its caller has accepted the call. None from a gateway that doesn’t say.

GatewayReadyData

</>

READY’s data.

pub type GatewayReadyData {
  GatewayReadyData(
    user: user.GatewayUser,
    session_token: String,
    unread_rooms: option.Option(List(String)),
    last_read_rooms: option.Option(dict.Dict(String, String)),
    last_msg_rooms: option.Option(dict.Dict(String, String)),
    unread_convs: option.Option(List(String)),
    last_read_convs: option.Option(dict.Dict(String, String)),
    active_calls: option.Option(List(GatewayReadyActiveCall)),
    spaces: option.Option(List(space.GatewaySpace)),
    ice_servers: List(IceServer),
    guild_ids: List(String),
  )
}

Constructors

GatewayReadyData(
  user: user.GatewayUser,
  session_token: String,
  unread_rooms: option.Option(List(String)),
  last_read_rooms: option.Option(dict.Dict(String, String)),
  last_msg_rooms: option.Option(dict.Dict(String, String)),
  unread_convs: option.Option(List(String)),
  last_read_convs: option.Option(dict.Dict(String, String)),
  active_calls: option.Option(List(GatewayReadyActiveCall)),
  spaces: option.Option(List(space.GatewaySpace)),
  ice_servers: List(IceServer),
  guild_ids: List(String),
)

Arguments

session_token: camelCase in the payload, as the gateway writes it.
last_read_convs: Each conversation’s read position, by conversation ID.
ice_servers: The STUN and TURN servers for voice and calls; none in a bot’s READY.
guild_ids: The spaces whose SPACE_CREATE comes after READY, by ID.

IceServer

</>

A STUN or TURN server for a peer connection, as READY hands them out.

pub type IceServer {
  IceServer(
    urls: List(String),
    username: option.Option(String),
    credential: option.Option(String),
  )
}

Constructors

IceServer(
  urls: List(String),
  username: option.Option(String),
  credential: option.Option(String),
)

Values

call_voice_state_from_json

</>

pub fn call_voice_state_from_json(
  object: dict.Dict(String, dynamic.Dynamic),
) -> CallVoiceState

ice_server_from_json

</>

pub fn ice_server_from_json(
  object: dict.Dict(String, dynamic.Dynamic),
) -> IceServer

urls may be one URL or a list; a credential that isn’t a password (an OAuth one) is left out.

ice_server_to_json

</>

pub fn ice_server_to_json(server: IceServer) -> json.Json

ready_active_call_from_json

</>

pub fn ready_active_call_from_json(
  object: dict.Dict(String, dynamic.Dynamic),
) -> GatewayReadyActiveCall

ready_data_from_json

</>

pub fn ready_data_from_json(
  object: dict.Dict(String, dynamic.Dynamic),
) -> GatewayReadyData