class Discord::Client

• Discord::Client
• Reference
• Object

Overview

The basic client class that is used to connect to Discord, send REST requests, or send or receive gateway messages. It is required for doing any sort of interaction with Discord.

A new simple client that does nothing yet can be created like this:

client = Discord::Client.new(token: "Bot token", client_id: 123_u64)

With this client, REST requests can now be sent. (See the Discord::REST module.) A gateway connection can also be started using the #run method.

Included Modules

• Discord::REST

Defined in:

Constant Summary

DEFAULT_PROPERTIES = Gateway::IdentifyProperties.new(os: "Crystal", browser: "discordcr", device: "discordcr", referrer: "", referring_domain: "")

Default analytics properties sent in IDENTIFY

Log = Discord::Log.for("client")

OP_DISPATCH = 0

OP_HEARTBEAT = 1

OP_HEARTBEAT_ACK = 11

OP_HELLO = 10

OP_IDENTIFY = 2

OP_INVALID_SESSION = 9

OP_RECONNECT = 7

OP_REQUEST_GUILD_MEMBERS = 8

OP_RESUME = 6

OP_STATUS_UPDATE = 3

OP_VOICE_SERVER_PING = 5

OP_VOICE_STATE_UPDATE = 4

Constructors

• .new(token : String, client_id : UInt64 | Snowflake | Nil = nil, shard : Gateway::ShardKey | Nil = nil, large_threshold : Int32 = 100, compress : CompressMode = CompressMode::Stream, zlib_buffer_size : Int32 = (10 * 1024) * 1024, properties : Gateway::IdentifyProperties = DEFAULT_PROPERTIES, intents : Gateway::Intents | Nil = Gateway::Intents::Unprivileged)

  Creates a new bot with the given token and optionally the client_id.

Instance Method Summary

• #cache : Cache | Nil

  If this is set to any Cache, the data in the cache will be updated as the client receives the corresponding gateway dispatches.

• #cache=(cache : Cache | Nil)

  If this is set to any Cache, the data in the cache will be updated as the client receives the corresponding gateway dispatches.

• #client_id

  Returns this client's ID as provided in its associated Oauth2 application.

• #inject(packet : Discord::WebSocket::Packet)

  Injects a packet into the packet handler.

• #on_channel_create(&handler : Channel -> )

  Called when a channel has been created on a server the bot has access to, or when somebody has started a DM channel with the bot.

• #on_channel_delete(&handler : Channel -> )

  Called when a channel the bot has access to is deleted.

• #on_channel_pins_update(&handler : Gateway::ChannelPinsUpdatePayload -> )

  Called when a channel's pinned messages are updated, where a pin was either added or removed.

• #on_channel_update(&handler : Channel -> )

  Called when a channel's properties are updated, like the name or permission overwrites.

• #on_dispatch(&handler : Tuple(String, IO::Memory) -> )

  Called when the bot receives any kind of dispatch at all, even one that is otherwise unsupported.

• #on_guild_ban_add(&handler : Gateway::GuildBanPayload -> )

  Called when somebody is banned from a guild.

• #on_guild_ban_remove(&handler : Gateway::GuildBanPayload -> )

  Called when somebody is unbanned from a guild.

• #on_guild_create(&handler : Gateway::GuildCreatePayload -> )

  Called when the bot is added to a guild, a guild unavailable due to an outage becomes available again, or the guild is streamed after READY.

• #on_guild_delete(&handler : Gateway::GuildDeletePayload -> )

  Called when the bot leaves a guild or a guild becomes unavailable due to an outage.

• #on_guild_emoji_update(&handler : Gateway::GuildEmojiUpdatePayload -> )

  Called when a guild's emoji are updated.

• #on_guild_integrations_update(&handler : Gateway::GuildIntegrationsUpdatePayload -> )

  Called when a guild's integrations (Twitch, YouTube) are updated.

• #on_guild_member_add(&handler : Gateway::GuildMemberAddPayload -> )

  Called when somebody other than the bot joins a guild.

• #on_guild_member_remove(&handler : Gateway::GuildMemberRemovePayload -> )

  Called when somebody other than the bot leaves a guild.

• #on_guild_member_update(&handler : Gateway::GuildMemberUpdatePayload -> )

  Called when a member object is updated.

• #on_guild_members_chunk(&handler : Gateway::GuildMembersChunkPayload -> )

  Called when Discord sends a chunk of member objects after a #request_guild_members call.

• #on_guild_role_create(&handler : Gateway::GuildRolePayload -> )

  Called when a role is created on a guild.

• #on_guild_role_delete(&handler : Gateway::GuildRoleDeletePayload -> )

  Called when a role is deleted.

• #on_guild_role_update(&handler : Gateway::GuildRolePayload -> )

  Called when a role's properties are updated, for example name or colour.

• #on_guild_update(&handler : Guild -> )

  Called when a guild's properties, like name or verification level, are updated.

• #on_invite_create(&handler : Gateway::InviteCreatePayload -> )

  Called when an invite is created on a guild.

• #on_invite_delete(&handler : Gateway::InviteDeletePayload -> )

  Called when an invite is deleted.

• #on_message_create(&handler : Message -> )

  Called when a message is sent to a channel the bot has access to.

• #on_message_delete(&handler : Gateway::MessageDeletePayload -> )

  Called when a single message is deleted.

• #on_message_delete_bulk(&handler : Gateway::MessageDeleteBulkPayload -> )

  Called when multiple messages are deleted at once, due to a bot using the bulk-delete endpoint, or other actions.

• #on_message_reaction_add(&handler : Gateway::MessageReactionPayload -> )

  Called when a reaction is added to a message.

• #on_message_reaction_remove(&handler : Gateway::MessageReactionPayload -> )

  Called when a reaction is removed from a message.

• #on_message_reaction_remove_all(&handler : Gateway::MessageReactionRemoveAllPayload -> )

  Called when all reactions are removed at once from a message.

• #on_message_reaction_remove_emoji(&handler : Gateway::MessageReactionRemoveEmojiPayload -> )

  Called when all reactions of a single emoji are removed at once from a message.

• #on_message_update(&handler : Gateway::MessageUpdatePayload -> )

  Called when a message is updated.

• #on_presence_update(&handler : Gateway::PresenceUpdatePayload -> )

  Called when a user updates their status (online/idle/offline), the game they are playing, or their streaming status.

• #on_ready(&handler : Gateway::ReadyPayload -> )

  Called when the bot has successfully initiated a session with Discord.

• #on_resumed(&handler : Gateway::ResumedPayload -> )

  Called when the client has successfully resumed an existing connection after reconnecting.

• #on_stage_instance_create(&handler : StageInstance -> )

  Sent when a Stage instance is created.

• #on_stage_instance_delete(&handler : StageInstance -> )

  Sent when a Stage instance is deleted.

• #on_stage_instance_update(&handler : StageInstance -> )

  Sent when a Stage instance is updated.

• #on_thread_create(&handler : Channel -> )

  Sent when a thread is created, relevant to the current user, or when the current user is added to a thread.

• #on_thread_delete(&handler : Channel -> )

  Sent when a thread relevant to the current user is deleted.

• #on_thread_list_sync(&handler : Gateway::ThreadListSyncPayload -> )

  Sent when the current user gains access to a channel.

• #on_thread_member_update(&handler : ThreadMember -> )

  Sent when the thread member object for the current user is updated.

• #on_thread_members_update(&handler : Gateway::ThreadMembersUpdatePayload -> )

  Sent when anyone is added to or removed from a thread.

• #on_thread_update(&handler : Channel -> )

  Sent when a thread is updated.

• #on_typing_start(&handler : Gateway::TypingStartPayload -> )

  Called when somebody starts typing in a channel the bot has access to.

• #on_user_update(&handler : User -> )

  Called when the user properties of the bot itself are changed.

• #on_voice_server_update(&handler : Gateway::VoiceServerUpdatePayload -> )

  Called when a guild's voice server changes.

• #on_voice_state_update(&handler : VoiceState -> )

  Called when somebody joins or leaves a voice channel, moves to a different one, or is muted/unmuted/deafened/undeafened.

• #on_webhooks_update(&handler : Gateway::WebhooksUpdatePayload -> )

  Sent when a guild channel's webhook is created, updated, or deleted.

• #reconnect(should_resume = false, backoff_override = nil)

  Reconnects the websocket connection entirely.

• #request_guild_members(guild_id : UInt64, query : String = "", limit : Int32 = 0)

  Requests a full list of members to be sent for a specific guild.

• #resume(sequence : Int64 | Nil = nil)

  Sends a resume packet from the given sequence number, or alternatively the current session's last received sequence if none is given.

• #run

  Connects this client to the gateway.

• #session : Gateway::Session | Nil

  The internal session the client is currently using, necessary to create a voice client, for example

• #status_update(status : String | Nil = nil, game : GamePlaying | Nil = nil, afk : Bool = false, since : Int64 | Nil = nil)

  Sends a status update to Discord.

• #stop(code : HTTP::WebSocket::CloseCode = HTTP::WebSocket::CloseCode::NormalClosure)

  Closes the gateway connection permanently

• #voice_state_update(guild_id : UInt64, channel_id : UInt64 | Nil, self_mute : Bool, self_deaf : Bool)

  Sends a voice state update to Discord.

• #wait_for_reconnect

  Separate method to wait an ever-increasing amount of time before reconnecting after being disconnected in an unexpected way

• #websocket : Discord::WebSocket

  The internal websocket the client is currently using

Constructor Detail

Instance Method Detail