discord_gleam - v1.7.1

discord_gleam

The primary module of discord_gleam.
This module contains high-level functions to interact with the Discord API.
But you can always implement stuff yourself using the low-level functions from the rest of the library. \

Values

ban_member

</> 
pub fn ban_member(
  bot: bot.Bot,
  guild_id: String,
  user_id: String,
  reason: String,
) -> Result(Nil, @internal DiscordError)

bot

</> 
pub fn bot(
  token: String,
  client_id: String,
  intents: intents.Intents,
) -> bot.Bot

Create a new bot instance.

Example:

import discord_gleam/discord/intents

fn main() {
  let bot = discord_gleam.bot("TOKEN", "CLIENT_ID", intents.default()))
}

create_dm_channel

</> 
pub fn create_dm_channel(
  bot: bot.Bot,
  user_id: String,
) -> Result(channel.Channel, @internal DiscordError)

Create a DM channel with a user.
Returns a channel object, or a DiscordError if it fails.

delete_message

</> 
pub fn delete_message(
  bot: bot.Bot,
  channel_id: String,
  message_id: String,
  reason: String,
) -> Result(Nil, @internal DiscordError)

Deletes an message from a channel.
The reason will be what is shown in the audit log.

Example:

import discord_gleam

fn main() {
 ...

 discord_gleam.delete_message(
  bot,  
 "CHANNEL_ID",
 "MESSAGE_ID",
 "REASON",
 )
}

For an full example, see the `examples/delete_message.gleam` file.

edit_message

</> 
pub fn edit_message(
  bot: bot.Bot,
  channel_id: String,
  message_id: String,
  content: String,
  embeds: List(message.Embed),
) -> Result(Nil, @internal DiscordError)

Edits an existing message in a channel.
The message must have been sent by the bot itself.

interaction_reply_message

</> 
pub fn interaction_reply_message(
  interaction: interaction_create.InteractionCreatePacket,
  message: String,
  ephemeral: Bool,
) -> Result(Nil, @internal DiscordError)

Make a basic text reply to an interaction.

kick_member

</> 
pub fn kick_member(
  bot: bot.Bot,
  guild_id: String,
  user_id: String,
  reason: String,
) -> Result(Nil, @internal DiscordError)

Kicks an member from an server.
The reason will be what is shown in the audit log.

Example:

import discord_gleam

fn main() {
 ...

 discord_gleam.kick_member(bot, "GUILD_ID", "USER_ID", "REASON")
}

For an full example, see the `examples/kick.gleam` file.

register_global_commands

</> 
pub fn register_global_commands(
  bot: bot.Bot,
  commands: List(slash_command.SlashCommand),
) -> Result(
  Nil,
  #(slash_command.SlashCommand, @internal DiscordError),
)

Registers a global slash command.
Restarting your client might be required to see the changes. \

register_guild_commands

</> 
pub fn register_guild_commands(
  bot: bot.Bot,
  guild_id: String,
  commands: List(slash_command.SlashCommand),
) -> Result(
  Nil,
  #(slash_command.SlashCommand, @internal DiscordError),
)

Registers a guild-specific slash command.
Restarting your client might be required to see the changes. \

reply

</> 
pub fn reply(
  bot: bot.Bot,
  channel_id: String,
  message_id: String,
  message: String,
  embeds: List(message.Embed),
) -> Result(Nil, @internal DiscordError)

Reply to a message in a channel.

Example:

import discord_gleam

fn main() {
 ...

 discord_gleam.reply(bot, "CHANNEL_ID", "MESSAGE_ID", "Hello world!", [])
}

request_guild_members

</> 
pub fn request_guild_members(
  bot: bot.Bot,
  guild_id guild_id: String,
  option option: request_guild_members.RequestGuildMembersOption,
  presences presences: option.Option(Bool),
  nonce nonce: option.Option(String),
) -> Nil

Used to request all members of a guild. The server will send GUILD_MEMBERS_CHUNK events in response with up to 1000 members per chunk until all members that match the request have been sent.

Nonce can only be up to 32 bytes. If you send an invalid nonce it will be ignored and the reply member_chunk(s) will not have a nonce set.

run

</> 
pub fn run(
  bot: bot.Bot,
  event_handlers: List(fn(bot.Bot, event_handler.Packet) -> Nil),
) -> Nil

Start the event loop, with a set of event handlers.

Example:

import discord_gleam/discord/intents
import discord_gleam/event_handler

fn main() {
 let bot = discord_gleam.bot("TOKEN", "CLIENT_ID", intents.default())

 let event_handlers = [handler]

 discord_gleam.run(bot, event_handlers)
}

fn handler(bot: bot.Bot, packet: event_handler.Packet) {
 case packet {
  event_handler.ReadyPacket(ready) -> {
    logging.log(logging.Info, "Logged in as " <> ready.d.user.username)
  }

  _ -> Nil
 }
}

send_direct_message

</> 
pub fn send_direct_message(
  bot: bot.Bot,
  user_id: String,
  message: String,
  embeds: List(message.Embed),
) -> Result(Nil, @internal DiscordError)

Send a direct message to a user.
Same use as send_message, but use user_id instead of channel_id.
discord_gleam.send_direct_message(bot, "USER_ID", "Hello world!", [])

Note: This will return a DiscordError if the DM channel cant be made

send_message

</> 
pub fn send_message(
  bot: bot.Bot,
  channel_id: String,
  message: String,
  embeds: List(message.Embed),
) -> Result(
  message_send_response.MessageSendResponse,
  @internal DiscordError,
)

Send a message to a channel.

Example:

import discord_gleam

fn main() {
 ...

 let msg = discord_gleam.send_message(
  bot,  
  "CHANNEL_ID",
  "Hello world!",
  [] // embeds
 )
}

wipe_global_commands

</> 
pub fn wipe_global_commands(
  bot: bot.Bot,
) -> Result(Nil, @internal DiscordError)

Wipes all the global slash commands for the bot.
Restarting your client might be required to see the changes. \

wipe_guild_commands

</> 
pub fn wipe_guild_commands(
  bot: bot.Bot,
  guild_id: String,
) -> Result(Nil, @internal DiscordError)

Wipes all the guild slash commands for the bot.
Restarting your client might be required to see the changes. \

✨ Search Document