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)

Acknowledge a message has been read for the current user.

public static Task AcknowledgeMessageAsync(this Channel channel, Message message, MessageAckJson json)

Parameters

channel Channel

message Message

json MessageAckJson

Returns

Task

Remarks

User accounts only.

AcknowledgeMessageAsync(Channel, ulong, MessageAckJson)

Acknowledge a message has been read for the current user.

public static Task AcknowledgeMessageAsync(this Channel channel, ulong messageId, MessageAckJson json)

Parameters

channel Channel

messageId ulong

json MessageAckJson

Returns

Task

Remarks

User accounts only.

AddReactionAsync(Channel, Message, string)

Add a reaction to a message.

public static Task AddReactionAsync(this Channel channel, Message message, string emoji)

Parameters

channel Channel

message Message

emoji string

Returns

Task

Remarks

Requires ViewChannel and AddReactions in a guild channel.

AddReactionAsync(Channel, ulong, string)

Add a reaction to a message.

public static Task AddReactionAsync(this Channel channel, ulong messageId, string emoji)

Parameters

channel Channel

messageId ulong

emoji string

Returns

Task

Remarks

Requires ViewChannel and AddReactions in a guild channel.

BulkDeleteMessagesAsync(Channel, BulkDeleteMessagesRequest)

Delete many messages in a channel.

public static Task BulkDeleteMessagesAsync(this Channel channel, BulkDeleteMessagesRequest req)

Parameters

channel Channel

req BulkDeleteMessagesRequest

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

ClearMessageAcknowledgementAsync(Channel)

Clear message unreads for a channel.

public static Task ClearMessageAcknowledgementAsync(this Channel channel)

Parameters

channel Channel

Returns

Task

CreateWebhookAsync(Channel, string, string?)

Create a webhook for the guild channel.

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

Parameters

channel Channel

name string

avatar string

Returns

Task<Webhook>

Remarks

Requires ViewChannel and ManageWebhooks.

DeleteAsync(Channel)

Delete a channel.

public static Task DeleteAsync(this Channel channel)

Parameters

channel Channel

Returns

Task

Remarks

Requires ManageChannels for guild channels.

DeleteMessageAsync(Channel, Message)

Delete a message in a channel.

public static Task DeleteMessageAsync(this Channel channel, Message message)

Parameters

channel Channel

message Message

Returns

Task

Remarks

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

DeleteMessageAsync(Channel, ulong)

Delete a message in a channel.

public static Task DeleteMessageAsync(this Channel channel, ulong messageId)

Parameters

channel Channel

messageId ulong

Returns

Task

Remarks

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

DeleteMessageAttachmentAsync(Channel, Message, ulong)

Delete a attachment on a message.

public static Task DeleteMessageAttachmentAsync(this Channel channel, Message message, ulong attachmentId)

Parameters

channel Channel

message Message

attachmentId ulong

Returns

Task

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

DeleteMessageAttachmentAsync(Channel, ulong, ulong)

Delete a attachment on a message.

public static Task DeleteMessageAttachmentAsync(this Channel channel, ulong messageId, ulong attachmentId)

Parameters

channel Channel

messageId ulong

attachmentId ulong

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>?)

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)

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>

Returns

Task<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>?)

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)

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>

Returns

Task<Message>

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetInvitesAsync(Channel)

Get invites for a guild channel.

public static Task<IEnumerable<Invite>> GetInvitesAsync(this Channel channel)

Parameters

channel Channel

Returns

Task<IEnumerable<Invite>>

Remarks

Requires ViewChannel and ManageChannels.

GetMessageAsync(Channel, ulong)

Get a message in a channel.

public static Task<Message> GetMessageAsync(this Channel channel, ulong messageId)

Parameters

channel Channel

messageId ulong

Returns

Task<Message>

Remarks

Requires ViewChannel and ReadMessageHistory for guild channels.

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

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)

Parameters

channel Channel

limit int

beforeId ulong?

afterId ulong?

aroundId ulong?

queryParams RestClientQueryParams

Returns

Task<IEnumerable<Message>>

Remarks

Requires ReadMessageHistory for guild channels.

GetPinnedMessagesAsync(Channel, ChannelPinsQuery?)

Get pinned messages in a channel.

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

Parameters

channel Channel

query ChannelPinsQuery

Returns

Task<ChannelPins>

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetReactionsForEmojiAsync(Channel, Message, string)

Get reaction users for a certain emoji on a message.

public static Task<IEnumerable<User>> GetReactionsForEmojiAsync(this Channel channel, Message message, string emoji)

Parameters

channel Channel

message Message

emoji string

Returns

Task<IEnumerable<User>>

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetReactionsForEmojiAsync(Channel, ulong, string)

Get reaction users for a certain emoji on a message.

public static Task<IEnumerable<User>> GetReactionsForEmojiAsync(this Channel channel, ulong messageId, string emoji)

Parameters

channel Channel

messageId ulong

emoji string

Returns

Task<IEnumerable<User>>

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetVoiceEligibilityAsync(Channel)

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

public static Task<CallEligibility> GetVoiceEligibilityAsync(this Channel channel)

Parameters

channel Channel

Returns

Task<CallEligibility>

GetWebhooksAsync(Channel)

Get webhooks for a guild channel.

public static Task<IEnumerable<Webhook>> GetWebhooksAsync(this Channel channel)

Parameters

channel Channel

Returns

Task<IEnumerable<Webhook>>

Remarks

Requires ViewChannel and ManageWebhooks.

ModifyAsync(Channel, ChannelJson)

Modify a channel.

public static Task<Channel> ModifyAsync(this Channel channel, ChannelJson json)

Parameters

channel Channel

json ChannelJson

Returns

Task<Channel>

Remarks

Requires ManageChannels for guild channels.

PinMessageAsync(Channel, Message)

Pin a message in a channel.

public static Task PinMessageAsync(this Channel channel, Message message)

Parameters

channel Channel

message Message

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

PinMessageAsync(Channel, ulong)

Pin a message in a channel.

public static Task PinMessageAsync(this Channel channel, ulong messageId)

Parameters

channel Channel

messageId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

RemoveAllReactionsAsync(Channel, Message)

Remove all reactions on a message.

public static Task RemoveAllReactionsAsync(this Channel channel, Message message)

Parameters

channel Channel

message Message

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsAsync(Channel, ulong)

Remove all reactions on a message.

public static Task RemoveAllReactionsAsync(this Channel channel, ulong messageId)

Parameters

channel Channel

messageId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsForEmojiAsync(Channel, Message, string)

Remove all reactions for a specific emoji on a message.

public static Task RemoveAllReactionsForEmojiAsync(this Channel channel, Message message, string emoji)

Parameters

channel Channel

message Message

emoji string

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsForEmojiAsync(Channel, ulong, string)

Remove all reactions for a specific emoji on a message.

public static Task RemoveAllReactionsForEmojiAsync(this Channel channel, ulong messageId, string emoji)

Parameters

channel Channel

messageId ulong

emoji string

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveOwnReactionAsync(Channel, Message, string)

Remove a reaction on a message.

public static Task RemoveOwnReactionAsync(this Channel channel, Message message, string emoji)

Parameters

channel Channel

message Message

emoji string

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

RemoveOwnReactionAsync(Channel, ulong, string)

Remove a reaction on a message.

public static Task RemoveOwnReactionAsync(this Channel channel, ulong messageId, string emoji)

Parameters

channel Channel

messageId ulong

emoji string

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

RemoveUserReactionAsync(Channel, Message, string, User)

Remove a user's reaction on a message.

public static Task RemoveUserReactionAsync(this Channel channel, Message message, string emoji, User user)

Parameters

channel Channel

message Message

emoji string

user User

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveUserReactionAsync(Channel, Message, string, ulong)

Remove a user's reaction on a message.

public static Task RemoveUserReactionAsync(this Channel channel, Message message, string emoji, ulong userId)

Parameters

channel Channel

message Message

emoji string

userId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveUserReactionAsync(Channel, ulong, string, ulong)

Remove a user's reaction on a message.

public static Task RemoveUserReactionAsync(this Channel channel, ulong messageId, string emoji, ulong userId)

Parameters

channel Channel

messageId ulong

emoji string

userId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RingCallAsync(Channel, ulong[])

Voice call users.

public static Task RingCallAsync(this Channel channel, ulong[] recipients)

Parameters

channel Channel

recipients ulong[]

Returns

Task

Remarks

User account only.

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

Send a message in the channel.

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

Parameters

channel Channel

attachments List<AttachmentRequest>

content string

Returns

Task<Message>

Remarks

Requires ViewChannel and SendMessages for guild channels.

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

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)

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>

Returns

Task<Message>

Remarks

Requires ViewChannel and SendMessages for guild channels.

TriggerTypingIndicatorAsync(Channel)

Send a user typing status for the channel.

public static Task TriggerTypingIndicatorAsync(this Channel channel)

Parameters

channel Channel

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

UnPinMessageAsync(Channel, Message)

Remove a pinned message in a channel.

public static Task UnPinMessageAsync(this Channel channel, Message message)

Parameters

channel Channel

message Message

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

UnPinMessageAsync(Channel, ulong)

Remove a pinned message in a channel.

public static Task UnPinMessageAsync(this Channel channel, ulong messageId)

Parameters

channel Channel

messageId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

UpdateVoiceRegionAsync(Channel, string)

Update the voice region for a voice channel.

public static Task UpdateVoiceRegionAsync(this Channel channel, string region)

Parameters

channel Channel

region string

Returns

Task

Remarks

Requires ViewChannel and UpdateRtcRegion in a guild channel.