Class ChannelHelpers

Namespace

Fluxer.Net

Assembly

Fluxer.Net.dll

Http methods for Channel class.

public static class ChannelHelpers

Inheritance

object

ChannelHelpers

Methods

AcknowledgeMessageAsync(Channel, Message, MessageAckJson, RequestOptions?)

Acknowledge a message has been read for the current user.

public static Task AcknowledgeMessageAsync(this Channel channel, Message message, MessageAckJson json, RequestOptions? options = null)

Parameters

channel Channel

message Message

json MessageAckJson

options RequestOptions

Returns

Task

Remarks

User accounts only.

AcknowledgeMessageAsync(Channel, ulong, MessageAckJson, RequestOptions?)

Acknowledge a message has been read for the current user.

public static Task AcknowledgeMessageAsync(this Channel channel, ulong messageId, MessageAckJson json, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

json MessageAckJson

options RequestOptions

Returns

Task

Remarks

User accounts only.

AddReactionAsync(Channel, Message, string, RequestOptions?)

Add a reaction to a message.

public static Task AddReactionAsync(this Channel channel, Message message, string emoji, RequestOptions? options = null)

Parameters

channel Channel

message Message

emoji string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and AddReactions in a guild channel.

AddReactionAsync(Channel, ulong, string, RequestOptions?)

Add a reaction to a message.

public static Task AddReactionAsync(this Channel channel, ulong messageId, string emoji, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

emoji string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and AddReactions in a guild channel.

BulkDeleteMessagesAsync(Channel, HashSet<ulong>, RequestOptions?)

Delete many messages in a channel.

public static Task BulkDeleteMessagesAsync(this Channel channel, HashSet<ulong> messageIds, RequestOptions? options = null)

Parameters

channel Channel

messageIds HashSet<ulong>

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

ClearMessageAcknowledgementAsync(Channel, RequestOptions?)

Clear message unreads for a channel.

public static Task ClearMessageAcknowledgementAsync(this Channel channel, RequestOptions? options = null)

Parameters

channel Channel

options RequestOptions

Returns

Task

CreateMessageThreadAsync(Channel, Message, CreatePublicThreadRequest, RequestOptions?)

Create a thread from a message

public static Task<ThreadChannel> CreateMessageThreadAsync(this Channel channel, Message message, CreatePublicThreadRequest req, RequestOptions? options = null)

Parameters

channel Channel

message Message

req CreatePublicThreadRequest

options RequestOptions

Returns

Task<ThreadChannel>

ThreadChannel

Remarks

Requires ViewChannel and CreatePublicThreads.

CreateMessageThreadAsync(Channel, ulong, CreatePublicThreadRequest, RequestOptions?)

Create a thread from a message

public static Task<ThreadChannel> CreateMessageThreadAsync(this Channel channel, ulong messageId, CreatePublicThreadRequest req, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

req CreatePublicThreadRequest

options RequestOptions

Returns

Task<ThreadChannel>

ThreadChannel

Remarks

Requires ViewChannel and CreatePublicThreads.

CreatePrivateThreadAsync(Channel, CreatePrivateThreadRequest, RequestOptions?)

Create a private thread.

public static Task<ThreadChannel> CreatePrivateThreadAsync(this Channel channel, CreatePrivateThreadRequest req, RequestOptions? options = null)

Parameters

channel Channel

req CreatePrivateThreadRequest

options RequestOptions

Returns

Task<ThreadChannel>

ThreadChannel

Remarks

Requires ViewChannel and CreatePrivateThreads.

CreatePublicThreadAsync(Channel, CreatePublicThreadRequest, RequestOptions?)

Create a public thread.

public static Task<ThreadChannel> CreatePublicThreadAsync(this Channel channel, CreatePublicThreadRequest req, RequestOptions? options = null)

Parameters

channel Channel

req CreatePublicThreadRequest

options RequestOptions

Returns

Task<ThreadChannel>

ThreadChannel

Remarks

Requires ViewChannel and CreatePublicThreads.

CreateWebhookAsync(Channel, string, string?, RequestOptions?)

Create a webhook for the guild channel.

public static Task<Webhook> CreateWebhookAsync(this Channel channel, string name, string? avatar = null, RequestOptions? options = null)

Parameters

channel Channel

name string

avatar string

options RequestOptions

Returns

Task<Webhook>

Webhook

Remarks

Requires ViewChannel and ManageWebhooks.

DeleteAsync(Channel, RequestOptions?)

Delete a channel.

public static Task DeleteAsync(this Channel channel, RequestOptions? options = null)

Parameters

channel Channel

options RequestOptions

Returns

Task

Remarks

Requires ManageChannel for guild channels.

DeleteMessageAsync(Channel, Message, RequestOptions?)

Delete a message in a channel.

public static Task DeleteMessageAsync(this Channel channel, Message message, RequestOptions? options = null)

Parameters

channel Channel

message Message

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.
ManageMessages for other user message.

DeleteMessageAsync(Channel, ulong, RequestOptions?)

Delete a message in a channel.

public static Task DeleteMessageAsync(this Channel channel, ulong messageId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.
ManageMessages for other user message.

DeleteMessageAttachmentAsync(Channel, Message, ulong, RequestOptions?)

Delete a attachment on a message.

public static Task DeleteMessageAttachmentAsync(this Channel channel, Message message, ulong attachmentId, RequestOptions? options = null)

Parameters

channel Channel

message Message

attachmentId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

DeleteMessageAttachmentAsync(Channel, ulong, ulong, RequestOptions?)

Delete a attachment on a message.

public static Task DeleteMessageAttachmentAsync(this Channel channel, ulong messageId, ulong attachmentId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

attachmentId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

EditMessageAsync(Channel, Message, string?, List<EmbedRequest>?, MessageReferenceRequest?, AllowedMentionsRequest?, MessageFlag, string?, ulong?, List<ulong>?, List<AttachmentRequest>?, RequestOptions?)

Modify your message in a channel

public static Task<Message> EditMessageAsync(this Channel channel, Message message, string? content = null, List<EmbedRequest>? embeds = null, MessageReferenceRequest? reference = null, AllowedMentionsRequest? allowedMentions = null, MessageFlag flags = MessageFlag.None, string? nonce = null, ulong? favoriteMediaId = null, List<ulong>? stickerIds = null, List<AttachmentRequest>? attachments = null, RequestOptions? options = null)

Parameters

channel Channel

message Message

content string

embeds List<EmbedRequest>

reference MessageReferenceRequest

allowedMentions AllowedMentionsRequest

flags MessageFlag

nonce string

favoriteMediaId ulong?

stickerIds List<ulong>

attachments List<AttachmentRequest>

options RequestOptions

Returns

Task<Message>

Message

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

EditMessageAsync(Channel, ulong, string?, List<EmbedRequest>?, MessageReferenceRequest?, AllowedMentionsRequest?, MessageFlag, string?, ulong?, List<ulong>?, List<AttachmentRequest>?, RequestOptions?)

Modify your message in a channel

public static Task<Message> EditMessageAsync(this Channel channel, ulong messageId, string? content = null, List<EmbedRequest>? embeds = null, MessageReferenceRequest? reference = null, AllowedMentionsRequest? allowedMentions = null, MessageFlag flags = MessageFlag.None, string? nonce = null, ulong? favoriteMediaId = null, List<ulong>? stickerIds = null, List<AttachmentRequest>? attachments = null, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

content string

embeds List<EmbedRequest>

reference MessageReferenceRequest

allowedMentions AllowedMentionsRequest

flags MessageFlag

nonce string

favoriteMediaId ulong?

stickerIds List<ulong>

attachments List<AttachmentRequest>

options RequestOptions

Returns

Task<Message>

Message

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

FollowAsync(Channel, Channel, RequestOptions?)

Follow a news channel.

public static Task FollowAsync(this Channel channel, Channel targetChannel, RequestOptions? options = null)

Parameters

channel Channel

targetChannel Channel

options RequestOptions

Returns

Task

FollowAsync(Channel, ulong, RequestOptions?)

Follow a news channel.

public static Task FollowAsync(this Channel channel, ulong targetChannelId, RequestOptions? options = null)

Parameters

channel Channel

targetChannelId ulong

options RequestOptions

Returns

Task

GetInvitesAsync(Channel, RequestOptions?)

Get invites for a guild channel.

public static Task<IEnumerable<Invite>> GetInvitesAsync(this Channel channel, RequestOptions? options = null)

Parameters

channel Channel

options RequestOptions

Returns

Task<IEnumerable<Invite>>

List of Invite

Remarks

Requires ViewChannel and ManageChannel.

GetMessageAsync(Channel, ulong, RequestOptions?)

Get a message in a channel.

public static Task<Message?> GetMessageAsync(this Channel channel, ulong messageId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

options RequestOptions

Returns

Task<Message>

Message

Remarks

Requires ViewChannel and ReadMessageHistory for guild channels.

GetMessagesAsync(Channel, int, ulong?, ulong?, ulong?, RestClientQueryParams?, RequestOptions?)

Get messages in a channel.

public static Task<IEnumerable<Message>> GetMessagesAsync(this Channel channel, int limit = 100, ulong? beforeId = null, ulong? afterId = null, ulong? aroundId = null, RestClientQueryParams? queryParams = null, RequestOptions? options = null)

Parameters

channel Channel

limit int

beforeId ulong?

afterId ulong?

aroundId ulong?

queryParams RestClientQueryParams

options RequestOptions

Returns

Task<IEnumerable<Message>>

List of Message

Remarks

Requires ReadMessageHistory for guild channels.

GetPinnedMessagesAsync(Channel, ChannelPinsQuery?, RequestOptions?)

Get pinned messages in a channel.

public static Task<ChannelPins> GetPinnedMessagesAsync(this Channel channel, ChannelPinsQuery? query = null, RequestOptions? options = null)

Parameters

channel Channel

query ChannelPinsQuery

options RequestOptions

Returns

Task<ChannelPins>

ChannelPins

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetReactionsForEmojiAsync(Channel, Message, string, RequestOptions?)

Get reaction users for a certain emoji on a message.

public static Task<IEnumerable<User>> GetReactionsForEmojiAsync(this Channel channel, Message message, string emoji, RequestOptions? options = null)

Parameters

channel Channel

message Message

emoji string

options RequestOptions

Returns

Task<IEnumerable<User>>

List of User

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetReactionsForEmojiAsync(Channel, ulong, string, RequestOptions?)

Get reaction users for a certain emoji on a message.

public static Task<IEnumerable<User>> GetReactionsForEmojiAsync(this Channel channel, ulong messageId, string emoji, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

emoji string

options RequestOptions

Returns

Task<IEnumerable<User>>

List of User

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetThreadChannelAsync(Channel, ulong, RequestOptions?)

Get a channel.

public static Task<ThreadChannel?> GetThreadChannelAsync(this Channel channel, ulong threadId, RequestOptions? options = null)

Parameters

channel Channel

threadId ulong

options RequestOptions

Returns

Task<ThreadChannel>

Channel

Remarks

Requires ViewChannel for guild channels.

GetVoiceEligibilityAsync(Channel, RequestOptions?)

Get if you can call a voice channel/group/dm.

public static Task<CallEligibility> GetVoiceEligibilityAsync(this Channel channel, RequestOptions? options = null)

Parameters

channel Channel

options RequestOptions

Returns

Task<CallEligibility>

CallEligibility

GetWebhooksAsync(Channel, RequestOptions?)

Get webhooks for a guild channel.

public static Task<IEnumerable<Webhook>> GetWebhooksAsync(this Channel channel, RequestOptions? options = null)

Parameters

channel Channel

options RequestOptions

Returns

Task<IEnumerable<Webhook>>

List of Webhook

Remarks

Requires ViewChannel and ManageWebhooks.

ModifyAsync(Channel, ChannelJson, RequestOptions?)

Modify a channel.

public static Task<Channel> ModifyAsync(this Channel channel, ChannelJson json, RequestOptions? options = null)

Parameters

channel Channel

json ChannelJson

options RequestOptions

Returns

Task<Channel>

Channel

Remarks

Requires ManageChannel for guild channels.

PinMessageAsync(Channel, Message, RequestOptions?)

Pin a message in a channel.

public static Task PinMessageAsync(this Channel channel, Message message, RequestOptions? options = null)

Parameters

channel Channel

message Message

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

PinMessageAsync(Channel, ulong, RequestOptions?)

Pin a message in a channel.

public static Task PinMessageAsync(this Channel channel, ulong messageId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

RemoveAllReactionsAsync(Channel, Message, RequestOptions?)

Remove all reactions on a message.

public static Task RemoveAllReactionsAsync(this Channel channel, Message message, RequestOptions? options = null)

Parameters

channel Channel

message Message

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsAsync(Channel, ulong, RequestOptions?)

Remove all reactions on a message.

public static Task RemoveAllReactionsAsync(this Channel channel, ulong messageId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsForEmojiAsync(Channel, Message, string, RequestOptions?)

Remove all reactions for a specific emoji on a message.

public static Task RemoveAllReactionsForEmojiAsync(this Channel channel, Message message, string emoji, RequestOptions? options = null)

Parameters

channel Channel

message Message

emoji string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsForEmojiAsync(Channel, ulong, string, RequestOptions?)

Remove all reactions for a specific emoji on a message.

public static Task RemoveAllReactionsForEmojiAsync(this Channel channel, ulong messageId, string emoji, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

emoji string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveOwnReactionAsync(Channel, Message, string, RequestOptions?)

Remove a reaction on a message.

public static Task RemoveOwnReactionAsync(this Channel channel, Message message, string emoji, RequestOptions? options = null)

Parameters

channel Channel

message Message

emoji string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

RemoveOwnReactionAsync(Channel, ulong, string, RequestOptions?)

Remove a reaction on a message.

public static Task RemoveOwnReactionAsync(this Channel channel, ulong messageId, string emoji, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

emoji string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

RemoveUserReactionAsync(Channel, Message, string, User, RequestOptions?)

Remove a user's reaction on a message.

public static Task RemoveUserReactionAsync(this Channel channel, Message message, string emoji, User user, RequestOptions? options = null)

Parameters

channel Channel

message Message

emoji string

user User

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveUserReactionAsync(Channel, Message, string, ulong, RequestOptions?)

Remove a user's reaction on a message.

public static Task RemoveUserReactionAsync(this Channel channel, Message message, string emoji, ulong userId, RequestOptions? options = null)

Parameters

channel Channel

message Message

emoji string

userId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveUserReactionAsync(Channel, ulong, string, ulong, RequestOptions?)

Remove a user's reaction on a message.

public static Task RemoveUserReactionAsync(this Channel channel, ulong messageId, string emoji, ulong userId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

emoji string

userId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RingCallAsync(Channel, ulong[], RequestOptions?)

Voice call users.

public static Task RingCallAsync(this Channel channel, ulong[] recipients, RequestOptions? options = null)

Parameters

channel Channel

recipients ulong[]

options RequestOptions

Returns

Task

Remarks

User account only.

SendFilesAsync(Channel, List<AttachmentRequest>?, string?, RequestOptions?)

Send a message in the channel.

public static Task<Message> SendFilesAsync(this Channel channel, List<AttachmentRequest>? attachments, string? content = null, RequestOptions? options = null)

Parameters

channel Channel

attachments List<AttachmentRequest>

content string

options RequestOptions

Returns

Task<Message>

Message

Remarks

Requires ViewChannel and SendMessages for guild channels.

SendMessageAsync(Channel, string?, List<EmbedRequest>?, MessageReferenceRequest?, AllowedMentionsRequest?, MessageFlag, string?, ulong?, bool?, List<ulong>?, List<AttachmentRequest>?, RequestOptions?)

Send a message in the channel.

public static Task<Message> SendMessageAsync(this Channel channel, string? content = null, List<EmbedRequest>? embeds = null, MessageReferenceRequest? reference = null, AllowedMentionsRequest? allowedMentions = null, MessageFlag flags = MessageFlag.None, string? nonce = null, ulong? favoriteMediaId = null, bool? tts = null, List<ulong>? stickerIds = null, List<AttachmentRequest>? attachments = null, RequestOptions? options = null)

Parameters

channel Channel

content string

embeds List<EmbedRequest>

reference MessageReferenceRequest

allowedMentions AllowedMentionsRequest

flags MessageFlag

nonce string

favoriteMediaId ulong?

tts bool?

stickerIds List<ulong>

attachments List<AttachmentRequest>

options RequestOptions

Returns

Task<Message>

Message

Remarks

Requires ViewChannel and SendMessages for guild channels.

TriggerTypingIndicatorAsync(Channel, RequestOptions?)

Send a user typing status for the channel.

public static Task TriggerTypingIndicatorAsync(this Channel channel, RequestOptions? options = null)

Parameters

channel Channel

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

UnPinMessageAsync(Channel, Message, RequestOptions?)

Remove a pinned message in a channel.

public static Task UnPinMessageAsync(this Channel channel, Message message, RequestOptions? options = null)

Parameters

channel Channel

message Message

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

UnPinMessageAsync(Channel, ulong, RequestOptions?)

Remove a pinned message in a channel.

public static Task UnPinMessageAsync(this Channel channel, ulong messageId, RequestOptions? options = null)

Parameters

channel Channel

messageId ulong

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

UpdateVoiceRegionAsync(Channel, string, RequestOptions?)

Update the voice region for a voice channel.

public static Task UpdateVoiceRegionAsync(this Channel channel, string region, RequestOptions? options = null)

Parameters

channel Channel

region string

options RequestOptions

Returns

Task

Remarks

Requires ViewChannel and UpdateRTCRegion in a guild channel.