grom - v1.0.0

grom/gateway

Types

AuditLogEntryCreatedMessage

</> 
pub type AuditLogEntryCreatedMessage {
  AuditLogEntryCreatedMessage(
    entry: audit_log.Entry,
    guild_id: String,
  )
}

Constructors

AutoModerationActionExecutedMessage

</> 
pub type AutoModerationActionExecutedMessage {
  AutoModerationActionExecutedMessage(
    guild_id: String,
    action: auto_moderation.Action,
    rule_id: String,
    rule_trigger_type: auto_moderation.TriggerType,
    user_id: String,
    channel_id: option.Option(String),
    message_id: option.Option(String),
    alert_system_message_id: option.Option(String),
    content: option.Option(String),
    matched_keyword: option.Option(String),
    matched_content: option.Option(String),
  )
}

Constructors

Builder

opaque </> 
pub opaque type Builder(state)

ChannelPinsUpdatedMessage

</> 
pub type ChannelPinsUpdatedMessage {
  ChannelPinsUpdatedMessage(
    guild_id: option.Option(String),
    channel_id: String,
    last_pin_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors

ClientStatus

</> 
pub type ClientStatus {
  ClientStatus(
    desktop: option.Option(String),
    mobile: option.Option(String),
    web: option.Option(String),
  )
}

Constructors

Connection

opaque </> 
pub opaque type Connection(user_state)

ConnectionManagerMessage

opaque </> 
pub opaque type ConnectionManagerMessage(user_state)

Data

</> 
pub type Data {
  Data(
    url: String,
    recommended_shards: Int,
    session_start_limits: SessionStartLimits,
  )
}

Constructors

DispatchedMessage

</> 
pub type DispatchedMessage {
  Ready(ReadyMessage)
  Resumed
  RateLimited(RateLimitedMessage)
  ApplicationCommandPermissionsUpdated(command.GuildPermissions)
  AutoModerationRuleCreated(auto_moderation.Rule)
  AutoModerationRuleUpdated(auto_moderation.Rule)
  AutoModerationRuleDeleted(auto_moderation.Rule)
  AutoModerationActionExecuted(
    AutoModerationActionExecutedMessage,
  )
  ChannelCreated(channel.Channel)
  ChannelUpdated(channel.Channel)
  ChannelDeleted(channel.Channel)
  ThreadCreated(ThreadCreatedMessage)
  ThreadUpdated(thread.Thread)
  ThreadDeleted(ThreadDeletedMessage)
  ThreadListSynced(ThreadListSyncedMessage)
  ThreadMemberUpdated(ThreadMemberUpdatedMessage)
  PresenceUpdated(PresenceUpdatedMessage)
  ThreadMembersUpdated(ThreadMembersUpdatedMessage)
  ChannelPinsUpdated(ChannelPinsUpdatedMessage)
  EntitlementCreated(entitlement.Entitlement)
  EntitlementUpdated(entitlement.Entitlement)
  EntitlementDeleted(entitlement.Entitlement)
  GuildCreated(GuildCreatedMessage)
  GuildUpdated(guild.Guild)
  GuildDeleted(guild.UnavailableGuild)
  AuditLogEntryCreated(AuditLogEntryCreatedMessage)
  GuildBanCreated(GuildBanMessage)
  GuildBanDeleted(GuildBanMessage)
  GuildEmojisUpdated(GuildEmojisUpdatedMessage)
  GuildStickersUpdated(GuildStickersUpdatedMessage)
  GuildIntegrationsUpdated(GuildIntegrationsUpdatedMessage)
  GuildMemberCreated(GuildMemberCreatedMessage)
  GuildMemberDeleted(GuildMemberDeletedMessage)
  GuildMemberUpdated(GuildMemberUpdatedMessage)
  GuildMembersChunk(GuildMembersChunkMessage)
  RoleCreated(RoleCreatedMessage)
  RoleUpdated(RoleUpdatedMessage)
  RoleDeleted(RoleDeletedMessage)
  ScheduledEventCreated(scheduled_event.ScheduledEvent)
  ScheduledEventUpdated(scheduled_event.ScheduledEvent)
  ScheduledEventDeleted(scheduled_event.ScheduledEvent)
  ScheduledEventUserCreated(ScheduledEventUserMessage)
  ScheduledEventUserDeleted(ScheduledEventUserMessage)
  GuildSoundboardSoundCreated(soundboard.Sound)
  GuildSoundboardSoundUpdated(soundboard.Sound)
  GuildSoundboardSoundDeleted(GuildSoundboardSoundDeletedMessage)
  GuildSoundboardSoundsUpdated(
    GuildSoundboardSoundsUpdatedMessage,
  )
  SoundboardSounds(SoundboardSoundsMessage)
  IntegrationCreated(IntegrationCreatedMessage)
  IntegrationUpdated(IntegrationUpdatedMessage)
  IntegrationDeleted(IntegrationDeletedMessage)
  InviteCreated(InviteCreatedMessage)
  InviteDeleted(InviteDeletedMessage)
  MessageCreated(MessageCreatedMessage)
  MessageUpdated(MessageUpdatedMessage)
  MessageDeleted(MessageDeletedMessage)
  MessagesBulkDeleted(MessagesBulkDeletedMessage)
  MessageReactionCreated(MessageReactionCreatedMessage)
  MessageReactionDeleted(MessageReactionDeletedMessage)
  MessageAllReactionsDeleted(MessageAllReactionsDeletedMessage)
  MessageEmojiReactionsDeleted(
    MessageEmojiReactionsDeletedMessage,
  )
  TypingStarted(TypingStartedMessage)
  CurrentUserUpdated(user.User)
  VoiceChannelEffectSent(VoiceChannelEffectSentMessage)
  VoiceStateUpdated(voice.State)
  VoiceServerUpdated(VoiceServerUpdatedMessage)
  InteractionCreated(interaction.Interaction)
  StageInstanceCreated(stage_instance.StageInstance)
  StageInstanceUpdated(stage_instance.StageInstance)
  StageInstanceDeleted(stage_instance.StageInstance)
  SubscriptionCreated(subscription.Subscription)
  SubscriptionUpdated(subscription.Subscription)
  SubscriptionDeleted(subscription.Subscription)
  PollVoteCreated(PollVoteCreatedMessage)
  PollVoteDeleted(PollVoteDeletedMessage)
  UnknownDispatchedMessage
}

Constructors

Event

</> 
pub type Event {
  ReadyEvent(ReadyMessage)
  ErrorEvent(grom.Error)
  ResumedEvent
  RateLimitedEvent(RateLimitedMessage)
  ApplicationCommandPermissionsUpdatedEvent(
    command.GuildPermissions,
  )
  AutoModerationRuleCreatedEvent(auto_moderation.Rule)
  AutoModerationRuleUpdatedEvent(auto_moderation.Rule)
  AutoModerationRuleDeletedEvent(auto_moderation.Rule)
  AutoModerationActionExecutedEvent(
    AutoModerationActionExecutedMessage,
  )
  ChannelCreatedEvent(channel.Channel)
  ChannelUpdatedEvent(channel.Channel)
  ChannelDeletedEvent(channel.Channel)
  ThreadCreatedEvent(ThreadCreatedMessage)
  ThreadUpdatedEvent(thread.Thread)
  ThreadDeletedEvent(ThreadDeletedMessage)
  ThreadListSyncedEvent(ThreadListSyncedMessage)
  ThreadMemberUpdatedEvent(ThreadMemberUpdatedMessage)
  PresenceUpdatedEvent(PresenceUpdatedMessage)
  ThreadMembersUpdatedEvent(ThreadMembersUpdatedMessage)
  ChannelPinsUpdatedEvent(ChannelPinsUpdatedMessage)
  EntitlementCreatedEvent(entitlement.Entitlement)
  EntitlementUpdatedEvent(entitlement.Entitlement)
  EntitlementDeletedEvent(entitlement.Entitlement)
  GuildCreatedEvent(GuildCreatedMessage)
  GuildUpdatedEvent(guild.Guild)
  GuildDeletedEvent(guild.UnavailableGuild)
  AuditLogEntryCreatedEvent(AuditLogEntryCreatedMessage)
  GuildBanCreatedEvent(GuildBanMessage)
  GuildBanDeletedEvent(GuildBanMessage)
  GuildEmojisUpdatedEvent(GuildEmojisUpdatedMessage)
  GuildStickersUpdatedEvent(GuildStickersUpdatedMessage)
  GuildIntegrationsUpdatedEvent(GuildIntegrationsUpdatedMessage)
  GuildMemberCreatedEvent(GuildMemberCreatedMessage)
  GuildMemberDeletedEvent(GuildMemberDeletedMessage)
  GuildMemberUpdatedEvent(GuildMemberUpdatedMessage)
  GuildMembersChunkEvent(GuildMembersChunkMessage)
  RoleCreatedEvent(RoleCreatedMessage)
  RoleUpdatedEvent(RoleUpdatedMessage)
  RoleDeletedEvent(RoleDeletedMessage)
  ScheduledEventCreatedEvent(scheduled_event.ScheduledEvent)
  ScheduledEventUpdatedEvent(scheduled_event.ScheduledEvent)
  ScheduledEventDeletedEvent(scheduled_event.ScheduledEvent)
  ScheduledEventUserCreatedEvent(ScheduledEventUserMessage)
  ScheduledEventUserDeletedEvent(ScheduledEventUserMessage)
  GuildSoundboardSoundCreatedEvent(soundboard.Sound)
  GuildSoundboardSoundUpdatedEvent(soundboard.Sound)
  GuildSoundboardSoundDeletedEvent(
    GuildSoundboardSoundDeletedMessage,
  )
  GuildSoundboardSoundsUpdatedEvent(
    GuildSoundboardSoundsUpdatedMessage,
  )
  SoundboardSoundsEvent(SoundboardSoundsMessage)
  IntegrationCreatedEvent(IntegrationCreatedMessage)
  IntegrationUpdatedEvent(IntegrationUpdatedMessage)
  IntegrationDeletedEvent(IntegrationDeletedMessage)
  InviteCreatedEvent(InviteCreatedMessage)
  InviteDeletedEvent(InviteDeletedMessage)
  MessageCreatedEvent(MessageCreatedMessage)
  MessageUpdatedEvent(MessageUpdatedMessage)
  MessageDeletedEvent(MessageDeletedMessage)
  MessagesBulkDeletedEvent(MessagesBulkDeletedMessage)
  MessageReactionCreatedEvent(MessageReactionCreatedMessage)
  MessageReactionDeletedEvent(MessageReactionDeletedMessage)
  MessageAllReactionsDeletedEvent(
    MessageAllReactionsDeletedMessage,
  )
  MessageEmojiReactionsDeletedEvent(
    MessageEmojiReactionsDeletedMessage,
  )
  TypingStartedEvent(TypingStartedMessage)
  CurrentUserUpdatedEvent(user.User)
  VoiceChannelEffectSentEvent(VoiceChannelEffectSentMessage)
  VoiceStateUpdatedEvent(voice.State)
  VoiceServerUpdatedEvent(VoiceServerUpdatedMessage)
  InteractionCreatedEvent(interaction.Interaction)
  StageInstanceCreatedEvent(stage_instance.StageInstance)
  StageInstanceUpdatedEvent(stage_instance.StageInstance)
  StageInstanceDeletedEvent(stage_instance.StageInstance)
  SubscriptionCreatedEvent(subscription.Subscription)
  SubscriptionUpdatedEvent(subscription.Subscription)
  SubscriptionDeletedEvent(subscription.Subscription)
  PollVoteCreatedEvent(PollVoteCreatedMessage)
  PollVoteDeletedEvent(PollVoteDeletedMessage)
  UnknownEvent
}

Constructors

GuildBanMessage

</> 
pub type GuildBanMessage {
  GuildBanMessage(guild_id: String, user: user.User)
}

Constructors 

  • GuildBanMessage(guild_id: String, user: user.User)

GuildCreatedMessage

</> 
pub type GuildCreatedMessage {
  GuildCreatedMessage(
    guild: guild.Guild,
    joined_at: timestamp.Timestamp,
    is_large: Bool,
    member_count: Int,
    voice_states: List(voice.State),
    members: List(guild_member.GuildMember),
    channels: List(channel.Channel),
    threads: List(thread.Thread),
    presences: List(PresenceUpdatedMessage),
    stage_instances: List(stage_instance.StageInstance),
    scheduled_events: List(scheduled_event.ScheduledEvent),
    soundboard_sounds: List(soundboard.Sound),
  )
  UnavailableGuildCreatedMessage(guild.UnavailableGuild)
}

Constructors

GuildEmojisUpdatedMessage

</> 
pub type GuildEmojisUpdatedMessage {
  GuildEmojisUpdatedMessage(
    guild_id: String,
    emojis: List(emoji.Emoji),
  )
}

Constructors 

  • GuildEmojisUpdatedMessage(
  guild_id: String,
  emojis: List(emoji.Emoji),
)

GuildIntegrationsUpdatedMessage

</> 
pub type GuildIntegrationsUpdatedMessage {
  GuildIntegrationsUpdatedMessage(guild_id: String)
}

Constructors 

  • GuildIntegrationsUpdatedMessage(guild_id: String)

GuildMemberCreatedMessage

</> 
pub type GuildMemberCreatedMessage {
  GuildMemberCreatedMessage(
    guild_id: String,
    guild_member: guild_member.GuildMember,
  )
}

Constructors

GuildMemberDeletedMessage

</> 
pub type GuildMemberDeletedMessage {
  GuildMemberDeletedMessage(guild_id: String, user: user.User)
}

Constructors 

  • GuildMemberDeletedMessage(guild_id: String, user: user.User)

GuildMemberUpdatedMessage

</> 
pub type GuildMemberUpdatedMessage {
  GuildMemberUpdatedMessage(
    guild_id: String,
    role_ids: List(String),
    user: user.User,
    nick: modification.Modification(String),
    avatar_hash: option.Option(String),
    banner_hash: option.Option(String),
    joined_at: option.Option(timestamp.Timestamp),
    premium_since: option.Option(timestamp.Timestamp),
    is_deaf: option.Option(Bool),
    is_mute: option.Option(Bool),
    is_pending: option.Option(Bool),
    communication_disabled_until: modification.Modification(
      timestamp.Timestamp,
    ),
    flags: option.Option(List(guild_member.Flag)),
    avatar_decoration_data: modification.Modification(
      user.AvatarDecorationData,
    ),
  )
}

Constructors

GuildMembersChunkMessage

</> 
pub type GuildMembersChunkMessage {
  GuildMembersChunkMessage(
    guild_id: String,
    members: List(guild_member.GuildMember),
    chunk_index: Int,
    chunk_count: Int,
    not_found_ids: option.Option(List(String)),
    presences: option.Option(List(PresenceUpdatedMessage)),
    nonce: option.Option(String),
  )
}

Constructors

GuildSoundboardSoundDeletedMessage

</> 
pub type GuildSoundboardSoundDeletedMessage {
  GuildSoundboardSoundDeletedMessage(
    sound_id: String,
    guild_id: String,
  )
}

Constructors 

  • GuildSoundboardSoundDeletedMessage(
  sound_id: String,
  guild_id: String,
)

GuildSoundboardSoundsUpdatedMessage

</> 
pub type GuildSoundboardSoundsUpdatedMessage {
  GuildSoundboardSoundsUpdatedMessage(
    soundboard_sounds: List(soundboard.Sound),
    guild_id: String,
  )
}

Constructors 

  • GuildSoundboardSoundsUpdatedMessage(
  soundboard_sounds: List(soundboard.Sound),
  guild_id: String,
)

GuildStickersUpdatedMessage

</> 
pub type GuildStickersUpdatedMessage {
  GuildStickersUpdatedMessage(
    guild_id: String,
    stickers: List(sticker.Sticker),
  )
}

Constructors 

  • GuildStickersUpdatedMessage(
  guild_id: String,
  stickers: List(sticker.Sticker),
)

HeartbeatMessage

</> 
pub type HeartbeatMessage {
  HeartbeatMessage(last_sequence: option.Option(Int))
}

Constructors

HelloMessage

</> 
pub type HelloMessage {
  HelloMessage(heartbeat_interval: duration.Duration)
}

Constructors

IdentifyMessage

</> 
pub type IdentifyMessage {
  IdentifyMessage(
    token: String,
    properties: IdentifyProperties,
    supports_compression: Bool,
    max_offline_members: option.Option(Int),
    shard: option.Option(Shard),
    presence: option.Option(UpdatePresenceMessage),
    intents: List(intent.Intent),
  )
}

Constructors

IdentifyProperties

</> 
pub type IdentifyProperties {
  IdentifyProperties(os: String, browser: String, device: String)
}

Constructors 

  • IdentifyProperties(os: String, browser: String, device: String)

IntegrationCreatedMessage

</> 
pub type IntegrationCreatedMessage {
  IntegrationCreatedMessage(
    integration: integration.Integration,
    guild_id: String,
  )
}

Constructors

IntegrationDeletedMessage

</> 
pub type IntegrationDeletedMessage {
  IntegrationDeletedMessage(
    id: String,
    guild_id: String,
    application_id: option.Option(String),
  )
}

Constructors 

  • IntegrationDeletedMessage(
  id: String,
  guild_id: String,
  application_id: option.Option(String),
)

IntegrationUpdatedMessage

</> 
pub type IntegrationUpdatedMessage {
  IntegrationUpdatedMessage(
    integration: integration.Integration,
    guild_id: String,
  )
}

Constructors

InviteCreatedMessage

</> 
pub type InviteCreatedMessage {
  InviteCreatedMessage(
    channel_id: String,
    code: String,
    created_at: timestamp.Timestamp,
    guild_id: option.Option(String),
    inviter: option.Option(user.User),
    max_age: duration.Duration,
    max_uses: Int,
    target_type: option.Option(invite.TargetType),
    target_user: option.Option(user.User),
    target_application: option.Option(application.Application),
    is_temporary: Bool,
    uses: Int,
    expires_at: option.Option(timestamp.Timestamp),
  )
}

Constructors

InviteDeletedMessage

</> 
pub type InviteDeletedMessage {
  InviteDeletedMessage(
    channel_id: String,
    guild_id: option.Option(String),
    code: String,
  )
}

Constructors 

  • InviteDeletedMessage(
  channel_id: String,
  guild_id: option.Option(String),
  code: String,
)

MessageAllReactionsDeletedMessage

</> 
pub type MessageAllReactionsDeletedMessage {
  MessageAllReactionsDeletedMessage(
    channel_id: String,
    message_id: String,
    guild_id: option.Option(String),
  )
}

Constructors 

  • MessageAllReactionsDeletedMessage(
  channel_id: String,
  message_id: String,
  guild_id: option.Option(String),
)

MessageCreatedMessage

</> 
pub type MessageCreatedMessage {
  MessageCreatedMessage(
    message: message.Message,
    guild_id: option.Option(String),
    member: option.Option(guild_member.GuildMember),
    mentions: List(user.User),
  )
}

Constructors

MessageDeletedMessage

</> 
pub type MessageDeletedMessage {
  MessageDeletedMessage(
    id: String,
    channel_id: String,
    guild_id: option.Option(String),
  )
}

Constructors 

  • MessageDeletedMessage(
  id: String,
  channel_id: String,
  guild_id: option.Option(String),
)

MessageEmojiReactionsDeletedMessage

</> 
pub type MessageEmojiReactionsDeletedMessage {
  MessageEmojiReactionsDeletedMessage(
    channel_id: String,
    message_id: String,
    guild_id: option.Option(String),
    emoji: emoji.Emoji,
  )
}

Constructors 

  • MessageEmojiReactionsDeletedMessage(
  channel_id: String,
  message_id: String,
  guild_id: option.Option(String),
  emoji: emoji.Emoji,
)

MessageReactionCreatedMessage

</> 
pub type MessageReactionCreatedMessage {
  MessageReactionCreatedMessage(
    user_id: String,
    channel_id: String,
    message_id: String,
    guild_id: option.Option(String),
    member: option.Option(guild_member.GuildMember),
    emoji: emoji.Emoji,
    message_author_id: option.Option(String),
    is_burst: Bool,
    burst_colors: option.Option(List(String)),
    type_: reaction.Type,
  )
}

Constructors

MessageReactionDeletedMessage

</> 
pub type MessageReactionDeletedMessage {
  MessageReactionDeletedMessage(
    user_id: String,
    channel_id: String,
    message_id: String,
    guild_id: option.Option(String),
    emoji: emoji.Emoji,
    is_burst: Bool,
    type_: reaction.Type,
  )
}

Constructors

MessageUpdatedMessage

</> 
pub type MessageUpdatedMessage {
  MessageUpdatedMessage(
    message: message.Message,
    guild_id: option.Option(String),
    member: option.Option(guild_member.GuildMember),
    mentions: List(user.User),
  )
}

Constructors

MessagesBulkDeletedMessage

</> 
pub type MessagesBulkDeletedMessage {
  MessagesBulkDeletedMessage(
    ids: List(String),
    channel_id: String,
    guild_id: option.Option(String),
  )
}

Constructors 

  • MessagesBulkDeletedMessage(
  ids: List(String),
  channel_id: String,
  guild_id: option.Option(String),
)

Next

opaque </> 
pub opaque type Next(state)

PollVoteCreatedMessage

</> 
pub type PollVoteCreatedMessage {
  PollVoteCreatedMessage(
    user_id: String,
    channel_id: String,
    message_id: String,
    guild_id: option.Option(String),
    answer_id: Int,
  )
}

Constructors 

  • PollVoteCreatedMessage(
  user_id: String,
  channel_id: String,
  message_id: String,
  guild_id: option.Option(String),
  answer_id: Int,
)

PollVoteDeletedMessage

</> 
pub type PollVoteDeletedMessage {
  PollVoteDeletedMessage(
    user_id: String,
    channel_id: String,
    message_id: String,
    guild_id: option.Option(String),
    answer_id: Int,
  )
}

Constructors 

  • PollVoteDeletedMessage(
  user_id: String,
  channel_id: String,
  message_id: String,
  guild_id: option.Option(String),
  answer_id: Int,
)

PresenceStatus

</> 
pub type PresenceStatus {
  Online
  DoNotDisturb
  Idle
  Invisible
  Offline
}

Constructors 

  • Online
  • DoNotDisturb
  • Idle
  • Invisible
  • Offline

PresenceUpdatedMessage

</> 
pub type PresenceUpdatedMessage {
  PresenceUpdatedMessage(
    user_id: option.Option(String),
    guild_id: option.Option(String),
    status: option.Option(String),
    activities: option.Option(List(activity.Activity)),
    client_status: option.Option(ClientStatus),
  )
}

Constructors

RateLimitedMessage

</> 
pub type RateLimitedMessage {
  RateLimitedMessage(
    limited_opcode: Int,
    retry_after: duration.Duration,
    metadata: RateLimitedMetadata,
  )
}

Constructors

RateLimitedMetadata

</> 
pub type RateLimitedMetadata {
  RequestGuildMembersRateLimited(
    guild_id: String,
    nonce: option.Option(String),
  )
}

Constructors 

  • RequestGuildMembersRateLimited(
  guild_id: String,
  nonce: option.Option(String),
)

ReadyApplication

</> 
pub type ReadyApplication {
  ReadyApplication(id: String, flags: List(application.Flag))
}

Constructors

ReadyMessage

</> 
pub type ReadyMessage {
  ReadyMessage(
    api_version: Int,
    user: user.User,
    guilds: List(guild.UnavailableGuild),
    session_id: String,
    resume_gateway_url: String,
    shard: option.Option(Shard),
    application: ReadyApplication,
  )
}

Constructors

ReceivedMessage

</> 
pub type ReceivedMessage {
  Hello(HelloMessage)
  Dispatch(sequence: Int, message: DispatchedMessage)
  HeartbeatAcknowledged
  HeartbeatRequest
  ReconnectRequest
  InvalidSession(can_reconnect: Bool)
}

Constructors 

  • Hello(HelloMessage)
  • Dispatch(sequence: Int, message: DispatchedMessage)
  • HeartbeatAcknowledged
  • HeartbeatRequest
  • ReconnectRequest
  • InvalidSession(can_reconnect: Bool)

RequestGuildMembersMessage

</> 
pub type RequestGuildMembersMessage {
  RequestAllGuildMembersMessage(
    guild_id: String,
    with_presences: Bool,
    nonce: option.Option(String),
  )
  RequestGuildMembersByIdsMessage(
    guild_id: String,
    with_presences: Bool,
    nonce: option.Option(String),
    user_ids: List(String),
  )
  RequestGuildMembersByQueryMessage(
    guild_id: String,
    with_presences: Bool,
    nonce: option.Option(String),
    query: String,
    limit: Int,
  )
}

Constructors 

  • RequestAllGuildMembersMessage(
  guild_id: String,
  with_presences: Bool,
  nonce: option.Option(String),
)
  • RequestGuildMembersByIdsMessage(
  guild_id: String,
  with_presences: Bool,
  nonce: option.Option(String),
  user_ids: List(String),
)
  • RequestGuildMembersByQueryMessage(
  guild_id: String,
  with_presences: Bool,
  nonce: option.Option(String),
  query: String,
  limit: Int,
)

ResumeMessage

</> 
pub type ResumeMessage {
  ResumeMessage(
    token: String,
    session_id: String,
    last_sequence: Int,
  )
}

Constructors 

  • ResumeMessage(
  token: String,
  session_id: String,
  last_sequence: Int,
)

RoleCreatedMessage

</> 
pub type RoleCreatedMessage {
  RoleCreatedMessage(guild_id: String, role: role.Role)
}

Constructors 

  • RoleCreatedMessage(guild_id: String, role: role.Role)

RoleDeletedMessage

</> 
pub type RoleDeletedMessage {
  RoleDeletedMessage(guild_id: String, role_id: String)
}

Constructors 

  • RoleDeletedMessage(guild_id: String, role_id: String)

RoleUpdatedMessage

</> 
pub type RoleUpdatedMessage {
  RoleUpdatedMessage(guild_id: String, role: role.Role)
}

Constructors 

  • RoleUpdatedMessage(guild_id: String, role: role.Role)

ScheduledEventUserMessage

</> 
pub type ScheduledEventUserMessage {
  ScheduledEventUserMessage(
    scheduled_event_id: String,
    user_id: String,
    guild_id: String,
  )
}

Constructors 

  • ScheduledEventUserMessage(
  scheduled_event_id: String,
  user_id: String,
  guild_id: String,
)

SentMessage

</> 
pub type SentMessage {
  Heartbeat(HeartbeatMessage)
  Identify(IdentifyMessage)
  Resume(ResumeMessage)
}

Constructors

SessionStartLimits

</> 
pub type SessionStartLimits {
  SessionStartLimits(
    maximum_starts: Int,
    remaining_starts: Int,
    resets_after: duration.Duration,
    max_identify_requests_per_5_seconds: Int,
  )
}

Constructors 

  • SessionStartLimits(
  maximum_starts: Int,
  remaining_starts: Int,
  resets_after: duration.Duration,
  max_identify_requests_per_5_seconds: Int,
)

Shard

</> 
pub type Shard {
  Shard(id: Int, num_shards: Int)
}

Constructors 

  • Shard(id: Int, num_shards: Int)

SoundboardSoundsMessage

</> 
pub type SoundboardSoundsMessage {
  SoundboardSoundsMessage(
    soundboard_sounds: List(soundboard.Sound),
    guild_id: String,
  )
}

Constructors 

  • SoundboardSoundsMessage(
  soundboard_sounds: List(soundboard.Sound),
  guild_id: String,
)

ThreadCreatedMessage

</> 
pub type ThreadCreatedMessage {
  ThreadCreatedMessage(
    thread: thread.Thread,
    is_newly_created: Bool,
  )
}

Constructors 

  • ThreadCreatedMessage(
  thread: thread.Thread,
  is_newly_created: Bool,
)

ThreadDeletedMessage

</> 
pub type ThreadDeletedMessage {
  ThreadDeletedMessage(
    id: String,
    guild_id: String,
    parent_id: String,
    type_: thread.Type,
  )
}

Constructors 

  • ThreadDeletedMessage(
  id: String,
  guild_id: String,
  parent_id: String,
  type_: thread.Type,
)

ThreadListSyncedMessage

</> 
pub type ThreadListSyncedMessage {
  ThreadListSyncedMessage(
    guild_id: String,
    channel_ids: option.Option(List(String)),
    threads: List(thread.Thread),
    members: List(thread.Member),
  )
}

Constructors 

  • ThreadListSyncedMessage(
  guild_id: String,
  channel_ids: option.Option(List(String)),
  threads: List(thread.Thread),
  members: List(thread.Member),
)

    Arguments

    channel_ids

    If None, then threads are synced for the entire guild.

    members

    A list of thread members for the current user.

ThreadMemberUpdatedMessage

</> 
pub type ThreadMemberUpdatedMessage {
  ThreadMemberUpdatedMessage(
    thread_member: thread.Member,
    guild_id: String,
  )
}

Constructors 

  • ThreadMemberUpdatedMessage(
  thread_member: thread.Member,
  guild_id: String,
)

ThreadMembersUpdatedMessage

</> 
pub type ThreadMembersUpdatedMessage {
  ThreadMembersUpdatedMessage(
    id: String,
    guild_id: String,
    member_count: Int,
    added_members: option.Option(
      List(
        #(thread.Member, option.Option(PresenceUpdatedMessage)),
      ),
    ),
    removed_member_ids: option.Option(List(String)),
  )
}

Constructors

TypingStartedMessage

</> 
pub type TypingStartedMessage {
  TypingStartedMessage(
    channel_id: String,
    guild_id: option.Option(String),
    user_id: String,
    timestamp: timestamp.Timestamp,
    member: option.Option(guild_member.GuildMember),
  )
}

Constructors

UpdatePresenceMessage

</> 
pub type UpdatePresenceMessage {
  UpdatePresenceMessage(
    since: option.Option(timestamp.Timestamp),
    activities: List(activity.Activity),
    status: PresenceStatus,
    is_afk: Bool,
  )
}

Constructors

UpdateVoiceStateMessage

</> 
pub type UpdateVoiceStateMessage {
  UpdateVoiceStateMessage(
    guild_id: String,
    channel_id: option.Option(String),
    is_self_muted: Bool,
    is_self_deafened: Bool,
  )
}

Constructors 

  • UpdateVoiceStateMessage(
  guild_id: String,
  channel_id: option.Option(String),
  is_self_muted: Bool,
  is_self_deafened: Bool,
)

    Arguments

    channel_id

    Set to None if disconnecting.

UserMessage

opaque </> 
pub opaque type UserMessage(user_state)

VoiceChannelEffectSentMessage

</> 
pub type VoiceChannelEffectSentMessage {
  VoiceChannelEffectSentMessage(
    channel_id: String,
    guild_id: String,
    user_id: String,
    emoji: option.Option(emoji.Emoji),
    animation_type: option.Option(voice.AnimationType),
    animation_id: option.Option(Int),
    sound_id: option.Option(soundboard.SoundId),
    sound_volume: option.Option(Float),
  )
}

Constructors

VoiceServerUpdatedMessage

</> 
pub type VoiceServerUpdatedMessage {
  VoiceServerUpdatedMessage(
    token: String,
    guild_id: String,
    endpoint: option.Option(String),
  )
}

Constructors 

  • VoiceServerUpdatedMessage(
  token: String,
  guild_id: String,
  endpoint: option.Option(String),
)

Values

continue

</> 
pub fn continue(state: state) -> Next(state)

get_data

</> 
pub fn get_data(client: grom.Client) -> Result(Data, grom.Error)

identify

</> 
pub fn identify(
  client: grom.Client,
  intents intents: List(intent.Intent),
) -> IdentifyMessage

identify_with_presence

</> 
pub fn identify_with_presence(
  identify: IdentifyMessage,
  presence: UpdatePresenceMessage,
) -> IdentifyMessage

new

</> 
pub fn new(
  identify: IdentifyMessage,
  state: state,
) -> Builder(state)

on_event

</> 
pub fn on_event(
  builder: Builder(state),
  do handler: fn(state, Event, Connection(state)) -> Next(state),
) -> Builder(state)

request_guild_members

</> 
pub fn request_guild_members(
  connection_state: Connection(user_state),
  using message: RequestGuildMembersMessage,
) -> Nil

request_soundboard_sounds

</> 
pub fn request_soundboard_sounds(
  connection_state: Connection(user_state),
  for guild_ids: List(String),
) -> Nil

start

</> 
pub fn start(builder: Builder(state)) -> Result(Nil, grom.Error)

stop

</> 
pub fn stop() -> Next(state)

stop_abnormal

</> 
pub fn stop_abnormal(reason: String) -> Next(state)

update_presence

</> 
pub fn update_presence(
  connection_state: Connection(user_state),
  using message: UpdatePresenceMessage,
) -> Nil

update_voice_state

</> 
pub fn update_voice_state(
  connection_state: Connection(user_state),
  using message: UpdateVoiceStateMessage,
) -> Nil
✨ Search Document