Class ChannelMethods

Pin a message within a channel

Returns

Resolves the Promise on successful execution

Example

// Pin a message because it was a good meme
const client = new SnowTransfer("TOKEN")
client.channel.addChannelPinnedMessage("channel id", "message id", "Good meme")

Add a user to a thread

CurrentUser must be a member of the thread

Returns

Resolves the Promise on successful execution

Example

const client = new SnowTransfer("TOKEN")
client.channel.addThreadMember("thread id", "user id")

Bulk delete messages from a guild channel, messages may not be older than 2 weeks

Returns

Resolves the Promise on successful execution

Example

// Bulk deletes 2 messages with a reason of "spam"
const client = new SnowTransfer("TOKEN")
client.channel.bulkDeleteMessages("channel id", ["message id 1", "message id 2"], "spam")

Create an invite for a guild channel

If no data argument is passed, the invite will be created with the defaults

Returns

Invite object (with metadata)

Example

// Creates a unique permanent invite with infinite uses
const client = new SnowTransfer("TOKEN")
const invite = await client.channel.createChannelInvite("channel id", { max_age: 0, max_uses: 0, unique: true })

Creates a new Message within a channel or thread

Make sure to use a filename with a proper extension (e.g. png, jpeg, etc.) when you want to upload files

Returns

discord message object

Example

// Make a bot say "hi" within a channel
// createMessage sends the passed data as content, when you give it a string
const client = new SnowTransfer("TOKEN")
client.channel.createMessage("channel id", "hi")

Example

// Send a rich embed object
const client = new SnowTransfer("TOKEN")
const embedData = {
    title: "This is a nice embed",
    description: "But winter is so cold",
    fields: [
        { name: "Brr", value: "Insert snowflake emoji here" }
    ]
}
client.channel.createMessage("channel id", { embeds: [embedData] })

Example

// Send a file with a comment
const client = new SnowTransfer("TOKEN")
// fileData will be a buffer with the data of the png image.
const fileData = fs.readFileSync("nice_picture.png") // You should probably use fs.readFile, since it is asynchronous, synchronous methods block the thread.
client.channel.createMessage("channel id", { content: "This is a nice picture", files: [{ name: "Optional_Filename.png", file: fileData }] })

Adds a reaction to a message

Returns

Resolves the Promise on successful execution

Example

// This example uses a discord emoji
const client = new SnowTransfer("TOKEN")
client.channel.createReaction("channel Id", "message Id", encodeURIComponent("awooo:322522663304036352"))

Example

// using a utf-8 emoji
const client = new SnowTransfer("TOKEN")
client.channel.createReaction("channel Id", "message Id", encodeURIComponent("😀"))

Creates a public thread off a message in a guild channel

Returns

thread channel object

Example

// Create a thread off a cool art piece to discuss
const client = new SnowTransfer("TOKEN")
const thread = await client.channel.createThreadWithMessage("channel id", "message id", { name: "cool-art", reason: "I wanna talk about it!" })

Creates a thread under a guild channel without a message

Returns

thread channel object

Example

// Creates a private thread that's invitable to talk about someone's birthday
const client = new SnowTransfer("TOKEN")
const thread = await client.channel.createThreadWithoutMessage("channel id", { name: "persons-birthday", type: 12, invitable: true, reason: "Shh! It's a surprise" })

Crosspost a message in a news channel to all following channels

Returns

discord message object

Example

// Crosspost a message
const client = new SnowTransfer("TOKEN")
client.channel.crosspostMessage("channel id", "message id")

Delete all reactions from a message in a guild channel

Returns

Resolves the Promise on successful execution

Example

const client = new SnowTransfer("TOKEN")
client.channel.deleteAllReactions("channel Id", "message Id")

Delete a channel or thread via Id

This either deletes a Guild Channel/thread or closes a Direct Message Channel

Be careful with deleting Guild Channels as this cannot be undone!

When deleting a category, this does not delete the child channels of a category. They will just have their parent_id removed.

For community guilds, the rules channel and the community updates channel cannot be deleted.

Returns

discord channel object

Example

// Deletes a channel via id because it wasn't needed anymore
const client = new SnowTransfer("TOKEN")
client.channel.deleteChannel("channel id", "No longer needed")

Delete a permission overwrite from a guild channel

Returns

Resolves the Promise on successful execution

Example

// Deletes the permission overwrite of a user
const client = new SnowTransfer("TOKEN")
client.channel.deleteChannelPermission("channel id", "user id", "Abusing channel")

Delete a message

Returns

Resolves the Promise on successful execution

Example

// Delete a message
const client = new SnowTransfer("TOKEN")
client.channel.deleteMessage("channel id", "message id")

Delete a reaction from a message in a guild channel

Returns

Resolves the Promise on successful execution

Example

// This example uses a discord emoji
const client = new SnowTransfer("TOKEN")
client.channel.deleteReaction("channel Id", "message Id", encodeURIComponent("awooo:322522663304036352"), "user Id")

Example

// using a utf-8 emoji
const client = new SnowTransfer("TOKEN")
// If a user Id is not supplied, the emoji from that message will be removed for all users
client.channel.deleteReaction("channel Id", "message Id", encodeURIComponent("😀"))

Delete a reaction added by the current user from a message

Returns

Resolves the Promise on successful execution

Example

// This example uses a discord emoji
const client = new SnowTransfer("TOKEN")
client.channel.deleteReactionSelf("channel Id", "message Id", encodeURIComponent("awooo:322522663304036352"))

Example

// using a utf-8 emoji
const client = new SnowTransfer("TOKEN")
client.channel.deleteReactionSelf("channel Id", "message Id", encodeURIComponent("😀"))

Modify the permission overwrites of a guild channel

Returns

Resolves the Promise on successful execution

Example

// Edits the permissions of a user to allow viewing the channel only
const client = new SnowTransfer("TOKEN")
client.channel.editChannelPermission("channel id", "user id", { allow: String(1 << 10), type: 1 })

Edit a message sent by the current user or edit the message flags of another user's message

Returns

discord message object

Example

// Simple ping response const client = new SnowTransfer("TOKEN") const time = Date.now() const message = await client.channel.createMessage("channel id", "pong") client.channel.editMessage("channel id", message.id, pong ${Date.now() - time}ms)

Follow a news channel to another channel

Returns

A followed channel object

Example

// Follows a news channel to a text channel
const client = new SnowTransfer("TOKEN")
client.channel.followNewsChannel("news channel id", "text channel id")

Get a channel via Id

Returns

discord channel object

Example

const client = new SnowTransfer("TOKEN")
const channel = await client.channel.getChannel("channel id")

Gets all threads that are private and archived within a guild channel

CurrentUser must be a member of the thread if they do not have MANAGE_THREADS permissions

Returns

Object containing private threads, thread members of the CurrentUser, and if there are more results in the pagination

Example

const client = new SnowTransfer("TOKEN")
const result = await client.channel.getChannelArchivedPrivateThreads("channel id")

Gets all threads that are private and archived within a guild channel that the CurrentUser is apart of

CurrentUser must be a member of the thread if they do not have MANAGE_THREADS permissions

Returns

Object containing private threads, thread members of the CurrentUser, and if there are more results in the pagination

Example

const client = new SnowTransfer("TOKEN")
const result = await client.channel.getChannelArchivedPrivateThreadsUser("channel id")

Gets all threads that are public and archived within a guild channel

Returns

Object containing public threads, thread members of the CurrentUser, and if there are more results in the pagination

Example

const client = new SnowTransfer("TOKEN")
const result = await client.channel.getChannelArchivedPublicThreads("channel id")

Get a list of invites for a guild channel

Returns

Array of invite objects (with metadata)

Example

const client = new SnowTransfer("TOKEN")
const invites = await client.channel.getChannelInvites("channel id")

Get a single message via Id

Returns

discord message object

Example

// Get a single message from a channel via id
const client = new SnowTransfer("TOKEN")
const message = await client.channel.getChannelMessage("channel id", "message id")

Get a list of messages from a channel

Returns

Array of discord message objects

Example

// Fetch the last 20 messages from a channel
const client = new SnowTransfer("TOKEN")
const options = {
    limit: 20
}
const messages = await client.channel.getChannelMessages("channel id", options)

Get a list of pinned messages for a channel

Returns

Array of message objects

Example

const client = new SnowTransfer("TOKEN")
const messages = await client.channel.getPinnedMessages("channel id")

Get a list of users that reacted with a certain emoji on a certain message

Returns

Array of user objects

Example

// This example uses a discord emoji
const client = new SnowTransfer("TOKEN")
const reactions = await client.channel.getReactions("channel Id", "message Id", encodeURIComponent("awooo:322522663304036352"))

Gets a member of a thread

Returns

A thread member

Example

const client = new SnowTransfer("TOKEN")
const member = await client.channel.getThreadMember("thread id", "user id")

Gets all members within a thread

Returns

Array of thread members

Example

const client = new SnowTransfer("TOKEN")
const members = await client.channel.getThreadMembers("thread id")

Join a thread

Returns

Resolves the Promise on successful execution

Example

const client = new SnowTransfer("TOKEN")
client.channel.joinThread("thread id")

Leave a thread

Returns

Resolves the Promise on successful execution

Example

const client = new SnowTransfer("TOKEN")
client.channel.leaveThread("thread id")

Remove a pinned message from a channel

Returns

Resolves the Promise on successful execution

Example

// Remove a pinned message because mod abuse :(
const client = new SnowTransfer("TOKEN")
client.channel.removeChannelPinnedMessage("channel id", "message id", "Mod abuse")

Remove a user from a thread

Returns

Resolves the Promise on successful execution

Example

const client = new SnowTransfer("TOKEN")
client.channel.removeThreadMember("thread id", "user id")

Send an indicator that the current user is typing within a channel.

You should generally avoid this method unless used for longer computations (>1s)

Returns

Resolves the Promise on successful execution

Example

const client = new SnowTransfer("TOKEN")
client.channel.sendChannelTyping("channel id")

Update a guild channel or thread

Returns

discord channel object

Example

// This example updates a channel with the passed id to use "New Name" as its name and "Look at this cool topic" as the topic
const client = new SnowTransfer("TOKEN")
const updateData = {
    name: "New Name",
    topic: "Look at this cool topic"
}
client.channel.updateChannel("channel id", updateData)