Table of Contents

Class FluxerApiClient

Namespace
Fluxer.Net.Rest
Assembly
Fluxer.Net.dll

REST API client for the Fluxer platform. Provides methods for all Fluxer API endpoints including authentication, channels, guilds, users, messages, and more.

public class FluxerApiClient : FluxerBaseApiClient
Inheritance
object
FluxerApiClient
Inherited Members

Remarks

This client handles HTTP requests to the Fluxer API with automatic rate limiting, JSON serialization, and error handling. It supports both synchronous operations via REST and can be paired with FluxerGatewayClient for real-time events.

Methods

AcknowledgeMessageAsync(ulong, ulong, MessageAckJson)

Acknowledge a message has been read for the current user.

public Task AcknowledgeMessageAsync(ulong channelId, ulong messageId, MessageAckJson details)

Parameters

channelId ulong
messageId ulong
details MessageAckJson

Returns

Task

Remarks

User accounts only.

AddMemberRoleAsync(ulong, ulong, ulong)

Give role to a member in the guild.

public Task AddMemberRoleAsync(ulong guildId, ulong userId, ulong roleId)

Parameters

guildId ulong
userId ulong
roleId ulong

Returns

Task

Remarks

Requires ManageRoles.

AddReactionAsync(ulong, ulong, string)

Add a reaction to a message.

public Task AddReactionAsync(ulong channelId, ulong messageId, string emoji)

Parameters

channelId ulong
messageId ulong
emoji string

Returns

Task

Remarks

Requires ViewChannel and AddReactions in a guild channel.

AddRecipientAsync(ulong, ulong)

Add a user to a group channel.

public Task AddRecipientAsync(ulong channelId, ulong userId)

Parameters

channelId ulong
userId ulong

Returns

Task

Remarks

User account only.

BanMemberAsync(ulong, ulong, CreateGuildBanRequest)

Ban a member from the guild.

public Task BanMemberAsync(ulong guildId, ulong userId, CreateGuildBanRequest data)

Parameters

guildId ulong
userId ulong
data CreateGuildBanRequest

Returns

Task

Remarks

Requires BanMembers.

BulkDeleteMessagesAsync(ulong, BulkDeleteMessagesRequest)

Delete many messages in a channel.

public Task BulkDeleteMessagesAsync(ulong channelId, BulkDeleteMessagesRequest data)

Parameters

channelId ulong
data BulkDeleteMessagesRequest

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

CheckUsernameAvailabilityAsync(string, string)

Check if a username is available.

public Task<UsernameAvailableJson> CheckUsernameAvailabilityAsync(string username, string discriminator)

Parameters

username string
discriminator string

Returns

Task<UsernameAvailableJson>

ClearMessageAcknowledgementAsync(ulong)

Clear message unreads for a channel.

public Task ClearMessageAcknowledgementAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task

CreateEmojiAsync(ulong, CreateGuildEmojiRequest)

Create emojis for the guild.

public Task<GuildEmoji> CreateEmojiAsync(ulong guildId, CreateGuildEmojiRequest data)

Parameters

guildId ulong
data CreateGuildEmojiRequest

Returns

Task<GuildEmoji>

Remarks

Requires either CreateExpressions or ManageExpressions.

CreateEmojiBulkAsync(ulong, BulkCreateGuildEmojisRequest)

Create multiple emojis for a guild.

public Task<GuildEmojiBulkCreateJson> CreateEmojiBulkAsync(ulong guildId, BulkCreateGuildEmojisRequest data)

Parameters

guildId ulong
data BulkCreateGuildEmojisRequest

Returns

Task<GuildEmojiBulkCreateJson>

Remarks

Requires either CreateExpressions or ManageExpressions.

CreateGuildAsync(CreateGuildRequest)

Create a guild.

public Task<Guild> CreateGuildAsync(CreateGuildRequest data)

Parameters

data CreateGuildRequest

Returns

Task<Guild>

Remarks

User account only.

CreateGuildChannelAsync(ulong, CreateGuildChannelRequest)

Create a channel in the guild.

public Task<Channel> CreateGuildChannelAsync(ulong guildId, CreateGuildChannelRequest data)

Parameters

guildId ulong
data CreateGuildChannelRequest

Returns

Task<Channel>

Remarks

Requires ManageChannels.

CreateInviteAsync(ulong, CreateInviteRequest)

Create invite for the guild channel.

public Task<Invite> CreateInviteAsync(ulong channelId, CreateInviteRequest data)

Parameters

channelId ulong
data CreateInviteRequest

Returns

Task<Invite>

Remarks

Requires ViewChannel and CreateInstantInvite.

CreatePrivateChannelAsync(CreatePrivateChannelRequest)

Create a DM or Group channel.

public Task<Channel> CreatePrivateChannelAsync(CreatePrivateChannelRequest req)

Parameters

req CreatePrivateChannelRequest

Returns

Task<Channel>

CreateRoleAsync(ulong, CreateGuildRoleRequest)

Create a role in the guild.

public Task<Role> CreateRoleAsync(ulong guildId, CreateGuildRoleRequest data)

Parameters

guildId ulong
data CreateGuildRoleRequest

Returns

Task<Role>

Remarks

Requires ManageRoles.

CreateStickerAsync(ulong, CreateGuildStickerRequest)

Create stickers for a guild.

public Task<GuildSticker> CreateStickerAsync(ulong guildId, CreateGuildStickerRequest data)

Parameters

guildId ulong
data CreateGuildStickerRequest

Returns

Task<GuildSticker>

Remarks

Requires either CreateExpressions or ManageExpressions.

CreateStickerBulkAsync(ulong, BulkCreateGuildStickersRequest)

Create multiple stickers for a guild.

public Task<GuildStickerBulkCreateJson> CreateStickerBulkAsync(ulong guildId, BulkCreateGuildStickersRequest data)

Parameters

guildId ulong
data BulkCreateGuildStickersRequest

Returns

Task<GuildStickerBulkCreateJson>

Remarks

Requires either CreateExpressions or ManageExpressions.

CreateWebhookAsync(ulong, string, string?)

Create a webhook for the guild channel.

public Task<Webhook> CreateWebhookAsync(ulong channelId, string name, string? avatar = null)

Parameters

channelId ulong
name string
avatar string

Returns

Task<Webhook>

Remarks

Requires ViewChannel and ManageWebhooks.

DeleteAttachmentAsync(string)

Delete an attachment.

public Task DeleteAttachmentAsync(string uploadFilename)

Parameters

uploadFilename string

Returns

Task

DeleteChannelAsync(ulong)

Delete a channel.

public Task DeleteChannelAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task

Remarks

Requires ManageChannels for guild channels.

DeleteCurrentUserChannelPinAsync(ulong) 

public Task DeleteCurrentUserChannelPinAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task

DeleteCurrentUserFavoriteMediaAsync(ulong)

Delete your favorite media.

public Task DeleteCurrentUserFavoriteMediaAsync(ulong mediaId)

Parameters

mediaId ulong

Returns

Task

DeleteCurrentUserMentionAsync(ulong)

Delete current user mentioned notifications.

public Task DeleteCurrentUserMentionAsync(ulong messageId)

Parameters

messageId ulong

Returns

Task

Remarks

User account only.

DeleteCurrentUserMfaWebauthnCredentialAsync(ulong) 

public Task DeleteCurrentUserMfaWebauthnCredentialAsync(ulong credentialId)

Parameters

credentialId ulong

Returns

Task

DeleteCurrentUserPhoneAsync<TRequest>(TRequest)

Remove phone number for current user.

public Task DeleteCurrentUserPhoneAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

Remarks

User account only.

DeleteCurrentUserPushSubscriptionAsync(ulong) 

public Task DeleteCurrentUserPushSubscriptionAsync(ulong subscriptionId)

Parameters

subscriptionId ulong

Returns

Task

DeleteCurrentUserRelationshipAsync(ulong) 

public Task DeleteCurrentUserRelationshipAsync(ulong userId)

Parameters

userId ulong

Returns

Task

DeleteCurrentUserSavedMessageAsync(ulong) 

public Task DeleteCurrentUserSavedMessageAsync(ulong messageId)

Parameters

messageId ulong

Returns

Task

DeleteEmojiAsync(ulong, ulong)

Delete an emoji in the guild.

public Task DeleteEmojiAsync(ulong guildId, ulong emojiId)

Parameters

guildId ulong
emojiId ulong

Returns

Task

Remarks

Requires either CreateExpressions or ManageExpressions.

DeleteGuildAsync(ulong, DeleteGuildRequest)

Delete a guild that you own.

public Task DeleteGuildAsync(ulong guildId, DeleteGuildRequest data)

Parameters

guildId ulong
data DeleteGuildRequest

Returns

Task

DeleteInviteAsync(string)

Delete an invite.

public Task DeleteInviteAsync(string inviteCode)

Parameters

inviteCode string

Returns

Task

DeleteMessageAsync(ulong, ulong)

Delete a message in a channel.

public Task DeleteMessageAsync(ulong channelId, ulong messageId)

Parameters

channelId ulong
messageId ulong

Returns

Task

Remarks

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

DeleteMessageAttachmentAsync(ulong, ulong, ulong)

Delete a attachment on a message.

public Task DeleteMessageAttachmentAsync(ulong channelId, ulong messageId, ulong attachmentId)

Parameters

channelId ulong
messageId ulong
attachmentId ulong

Returns

Task

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

DeleteRoleAsync(ulong, ulong)

Delete a role in the guild.

public Task DeleteRoleAsync(ulong guildId, ulong roleId)

Parameters

guildId ulong
roleId ulong

Returns

Task

Remarks

Requires ManageRoles.

DeleteStickerAsync(ulong, ulong)

Delete a sticker in the guild.

public Task DeleteStickerAsync(ulong guildId, ulong stickerId)

Parameters

guildId ulong
stickerId ulong

Returns

Task

Remarks

Requires either CreateExpressions or ManageExpressions.

DeleteWebhookAsync(ulong)

Delete webhook in a guild channel.

public Task DeleteWebhookAsync(ulong webhookId)

Parameters

webhookId ulong

Returns

Task

Remarks

Requires ManageWebhooks.

DeleteWebhookMessageAsync(ulong, string, ulong)

Delete a webhook message using the webhook token.

public Task DeleteWebhookMessageAsync(ulong webhookId, string token, ulong messageId)

Parameters

webhookId ulong
token string
messageId ulong

Returns

Task

DeleteWebhookWithTokenAsync(ulong, string)

Delete webhook using the webhook token.

public Task DeleteWebhookWithTokenAsync(ulong webhookId, string token)

Parameters

webhookId ulong
token string

Returns

Task

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

Modify your message in a channel

public Task<Message> EditMessageAsync(ulong channelId, 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

channelId ulong
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.

EditWebhookMessageAsync(ulong, string, ulong, string?, List<EmbedRequest>?, MessageReferenceRequest?, AllowedMentionsRequest?, MessageFlag, string?, ulong?, List<ulong>?, List<AttachmentRequest>?)

Modify a webhook message using the webhook token.

public Task<Message> EditWebhookMessageAsync(ulong webhookId, string token, 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

webhookId ulong
token string
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>

ExchangeOAuthRefreshTokenAsync(ulong, string, string)

Get new access token from refresh token.

public Task<FluxerOAuthRefreshToken> ExchangeOAuthRefreshTokenAsync(ulong clientId, string clientSecret, string refreshToken)

Parameters

clientId ulong
clientSecret string
refreshToken string

Returns

Task<FluxerOAuthRefreshToken>

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

Send message using the webhook token in a guild channel.

public Task ExecuteWebhookAsync(ulong webhookId, string token, string? content = null, List<EmbedRequest>? embeds = null, string? username = null, string? avatarUrl = 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

webhookId ulong
token string
content string
embeds List<EmbedRequest>
username string
avatarUrl string
reference MessageReferenceRequest
allowedMentions AllowedMentionsRequest
flags MessageFlag
nonce string
favoriteMediaId ulong?
tts bool?
stickerIds List<ulong>
attachments List<AttachmentRequest>

Returns

Task

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

Send message using the webhook token in a guild channel and wait for response message.

public Task<Message> ExecuteWebhookWaitAsync(ulong webhookId, string token, string? content = null, List<EmbedRequest>? embeds = null, string? username = null, string? avatarUrl = 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

webhookId ulong
token string
content string
embeds List<EmbedRequest>
username string
avatarUrl string
reference MessageReferenceRequest
allowedMentions AllowedMentionsRequest
flags MessageFlag
nonce string
favoriteMediaId ulong?
tts bool?
stickerIds List<ulong>
attachments List<AttachmentRequest>

Returns

Task<Message>

ForgotPasswordAsync<TRequest>(TRequest)

Request a password reset for the user account.

public Task ForgotPasswordAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

GetBansAsync(ulong)

Get bans for a guild.

public Task<IEnumerable<GuildBan>> GetBansAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<IEnumerable<GuildBan>>

Remarks

Requires BanMembers.

GetChannelAsync(ulong)

Get a channel.

public Task<Channel> GetChannelAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task<Channel>

Remarks

Requires ViewChannel for guild channels.

GetChannelInvitesAsync(ulong)

Get invites for a guild channel.

public Task<IEnumerable<Invite>> GetChannelInvitesAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task<IEnumerable<Invite>>

Remarks

Requires ViewChannel and ManageChannels.

GetChannelRtcRegionsAsync(ulong)

Get voice regions for a channel.

public Task<IEnumerable<RtcRegion>> GetChannelRtcRegionsAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task<IEnumerable<RtcRegion>>

Remarks

Requires ViewChannel for guild channels.

GetChannelWebhooksAsync(ulong)

Get webhooks for a guild channel.

public Task<IEnumerable<Webhook>> GetChannelWebhooksAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task<IEnumerable<Webhook>>

Remarks

Requires ViewChannel and ManageWebhooks.

GetChannelsAsync(ulong)

Get all channels in the guild.

public Task<IEnumerable<Channel>> GetChannelsAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<IEnumerable<Channel>>

Remarks

Requires ViewChannel.

GetCurrentApplicationAsync() 

public Task<CurrentApplication> GetCurrentApplicationAsync()

Returns

Task<CurrentApplication>

GetCurrentMemberAsync(ulong)

Get current member for a guild.

public Task<GuildMember> GetCurrentMemberAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<GuildMember>

GetCurrentUserAsync()

Get the current user.

public Task<CurrentUser> GetCurrentUserAsync()

Returns

Task<CurrentUser>

GetCurrentUserChannelsAsync<TResponse>() 

public Task<TResponse> GetCurrentUserChannelsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserFavoriteMediaAsync()

Get all your favorite media.

public Task<IEnumerable<FavoriteMedia>> GetCurrentUserFavoriteMediaAsync()

Returns

Task<IEnumerable<FavoriteMedia>>

GetCurrentUserFavoriteMediaAsync(ulong)

Get your favorite media.

public Task<FavoriteMedia> GetCurrentUserFavoriteMediaAsync(ulong mediaId)

Parameters

mediaId ulong

Returns

Task<FavoriteMedia>

GetCurrentUserGuildsAsync()

Get all guilds for the current user.

public Task<IEnumerable<Guild>> GetCurrentUserGuildsAsync()

Returns

Task<IEnumerable<Guild>>

GetCurrentUserHarvestAsync<TResponse>(string) 

public Task<TResponse> GetCurrentUserHarvestAsync<TResponse>(string harvestId)

Parameters

harvestId string

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserHarvestDownloadAsync<TResponse>(string) 

public Task<TResponse> GetCurrentUserHarvestDownloadAsync<TResponse>(string harvestId)

Parameters

harvestId string

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserHarvestLatestAsync<TResponse>() 

public Task<TResponse> GetCurrentUserHarvestLatestAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserMentionsAsync<TResponse>()

Get current user mention notifications.

public Task<TResponse> GetCurrentUserMentionsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

Remarks

User account only.

GetCurrentUserMfaWebauthnCredentialsAsync<TResponse>()

Get webauthn MFA for current user.

public Task<TResponse> GetCurrentUserMfaWebauthnCredentialsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

Remarks

User account only.

GetCurrentUserNoteAsync<TResponse>(ulong)

Get current user note for target user.

public Task<TResponse> GetCurrentUserNoteAsync<TResponse>(ulong targetId)

Parameters

targetId ulong

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserNotesAsync<TResponse>()

Get all current user notes.

public Task<TResponse> GetCurrentUserNotesAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserPushSubscriptionsAsync<TResponse>() 

public Task<TResponse> GetCurrentUserPushSubscriptionsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserRelationshipsAsync<TResponse>() 

public Task<TResponse> GetCurrentUserRelationshipsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserSavedMessagesAsync<TResponse>() 

public Task<TResponse> GetCurrentUserSavedMessagesAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

GetCurrentUserSettingsAsync()

Get current user settings.

public Task<UserSettings> GetCurrentUserSettingsAsync()

Returns

Task<UserSettings>

Remarks

User account only.

GetEmojiAsync(ulong)

Get a custom emoji.

public Task<Emoji?> GetEmojiAsync(ulong emojiId)

Parameters

emojiId ulong

Returns

Task<Emoji>

GetEmojisAsync(ulong)

Get all emojis in the guild.

public Task<IEnumerable<GuildEmoji>> GetEmojisAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<IEnumerable<GuildEmoji>>

Remarks

Requires either CreateExpressions or ManageExpressions.

GetGuildAsync(ulong)

Get a guild that the current user is in.

public Task<Guild> GetGuildAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<Guild>

GetGuildInvitesAsync(ulong)

Get all invites for the guild.

public Task<IEnumerable<Invite>> GetGuildInvitesAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<IEnumerable<Invite>>

Remarks

Requires ManageChannels.

GetGuildVanityUrlAsync(ulong)

Get vanity url for a guild.

public Task<GuildVanityUrl> GetGuildVanityUrlAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<GuildVanityUrl>

GetGuildWebhooksAsync(ulong)

Get all webhooks for the guild.

public Task<IEnumerable<Webhook>> GetGuildWebhooksAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<IEnumerable<Webhook>>

Remarks

Requires ManageWebhooks.

GetInstanceAsync()

Get info and config for the Fluxer instance, useful for self-hosted.

public Task<Instance?> GetInstanceAsync()

Returns

Task<Instance>

GetInviteAsync(string)

Get invite info from invite code.

public Task<PartialInvite> GetInviteAsync(string inviteCode)

Parameters

inviteCode string

Returns

Task<PartialInvite>

GetKlipyFeaturedAsync()

Get featured klipy gifs.

public Task<GifFeaturedJson> GetKlipyFeaturedAsync()

Returns

Task<GifFeaturedJson>

GetKlipyTrendingGifsAsync()

Get trending klipy gifs.

public Task<IEnumerable<Gif>> GetKlipyTrendingGifsAsync()

Returns

Task<IEnumerable<Gif>>

GetMemberAsync(ulong, ulong)

Get a member in a guild.

public Task<GuildMember> GetMemberAsync(ulong guildId, ulong userId)

Parameters

guildId ulong
userId ulong

Returns

Task<GuildMember>

GetMembersAsync(ulong, int, ulong?, RestClientQueryParams?)

Get a list of members for a guild, default and maximum 1000.

public Task<IEnumerable<GuildMember>> GetMembersAsync(ulong guildId, int limit = 1000, ulong? afterId = null, RestClientQueryParams? queryParams = null)

Parameters

guildId ulong
limit int
afterId ulong?
queryParams RestClientQueryParams

Returns

Task<IEnumerable<GuildMember>>

GetMessageAsync(ulong, ulong)

Get a message in a channel.

public Task<Message> GetMessageAsync(ulong channelId, ulong messageId)

Parameters

channelId ulong
messageId ulong

Returns

Task<Message>

Remarks

Requires ViewChannel and ReadMessageHistory for guild channels.

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

Get messages in a channel.

public Task<IEnumerable<Message>> GetMessagesAsync(ulong channelId, int limit = 100, ulong? beforeId = null, ulong? afterId = null, ulong? aroundId = null, RestClientQueryParams? queryParams = null)

Parameters

channelId ulong
limit int
beforeId ulong?
afterId ulong?
aroundId ulong?
queryParams RestClientQueryParams

Returns

Task<IEnumerable<Message>>

Remarks

Requires ReadMessageHistory for guild channels.

GetOAuthConnectionsAsync(string)

Get user connections from access token.

public Task<IEnumerable<UserConnection>> GetOAuthConnectionsAsync(string accessToken)

Parameters

accessToken string

Returns

Task<IEnumerable<UserConnection>>

GetOAuthGuildsAsync(string)

Get user guilds from access token.

public Task<IEnumerable<Guild>> GetOAuthGuildsAsync(string accessToken)

Parameters

accessToken string

Returns

Task<IEnumerable<Guild>>

GetOAuthTokenAsync(string)

Get oauth token from access token.

public Task<FluxerOAuthToken> GetOAuthTokenAsync(string accessToken)

Parameters

accessToken string

Returns

Task<FluxerOAuthToken>

GetOAuthUserAsync(string)

Get user from access token.

public Task<FluxerOAuthUser> GetOAuthUserAsync(string accessToken)

Parameters

accessToken string

Returns

Task<FluxerOAuthUser>

GetOAuthValidTokenAsync(ulong, string, string)

Check if oauth token is valid.

public Task<FluxerOAuthValidToken> GetOAuthValidTokenAsync(ulong clientId, string clientSecret, string accessToken)

Parameters

clientId ulong
clientSecret string
accessToken string

Returns

Task<FluxerOAuthValidToken>

GetPinnedMessagesAsync(ulong, ChannelPinsQuery?)

Get pinned messages in a channel.

public Task<ChannelPins> GetPinnedMessagesAsync(ulong channelId, ChannelPinsQuery? query = null)

Parameters

channelId ulong
query ChannelPinsQuery

Returns

Task<ChannelPins>

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetPublicAppAsync(ulong)

Get a public app.

public Task<Application?> GetPublicAppAsync(ulong id)

Parameters

id ulong

Returns

Task<Application>

GetReactionsForEmojiAsync(ulong, ulong, string)

Get reaction users for a certain emoji on a message.

public Task<IEnumerable<User>> GetReactionsForEmojiAsync(ulong channelId, ulong messageId, string emoji)

Parameters

channelId ulong
messageId ulong
emoji string

Returns

Task<IEnumerable<User>>

Remarks

Requires ViewChannel and ReadMessageHistory in a guild channel.

GetSessionsAsync(RestClientQueryParams?)

Get all sessions for the user account.

public Task<IEnumerable<AuthSession>> GetSessionsAsync(RestClientQueryParams? queryParams)

Parameters

queryParams RestClientQueryParams

Returns

Task<IEnumerable<AuthSession>>

GetStickerAsync(ulong)

Get a custom sticker.

public Task<Sticker?> GetStickerAsync(ulong stickerId)

Parameters

stickerId ulong

Returns

Task<Sticker>

GetStickersAsync(ulong)

Get all stickers in the guild.

public Task<IEnumerable<GuildSticker>> GetStickersAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task<IEnumerable<GuildSticker>>

Remarks

Requires either CreateExpressions or ManageExpressions.

GetUserAsync(ulong)

Get a user.

public Task<User> GetUserAsync(ulong userId)

Parameters

userId ulong

Returns

Task<User>

GetUserProfileAsync(ulong, string?, bool, bool)

Get a user's profile.

public Task<UserProfileResponse> GetUserProfileAsync(ulong targetId, string? guildId = null, bool mutualFriends = false, bool mutualGuilds = false)

Parameters

targetId ulong
guildId string
mutualFriends bool
mutualGuilds bool

Returns

Task<UserProfileResponse>

Remarks

Requires mutual friend or guild.

GetVoiceEligibilityAsync(ulong)

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

public Task<CallEligibility> GetVoiceEligibilityAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task<CallEligibility>

GetWebhookAsync(ulong)

Get webhook in a guild channel.

public Task<Webhook> GetWebhookAsync(ulong webhookId)

Parameters

webhookId ulong

Returns

Task<Webhook>

Remarks

Requires ManageWebhooks.

GetWebhookWithTokenAsync(ulong, string)

Get webhook using the webhook token.

public Task<Webhook> GetWebhookWithTokenAsync(ulong webhookId, string token)

Parameters

webhookId ulong
token string

Returns

Task<Webhook>

JoinGuildAsync(string)

Join a guild by invite code.

public Task<PartialInvite> JoinGuildAsync(string inviteCode)

Parameters

inviteCode string

Returns

Task<PartialInvite>

Remarks

User account only.

KickMemberAsync(ulong, ulong)

Kick a member from the guild.

public Task KickMemberAsync(ulong guildId, ulong userId)

Parameters

guildId ulong
userId ulong

Returns

Task

Remarks

Requires KickMembers.

LeaveGuildAsync(ulong)

Leave a guild for the current user.

public Task LeaveGuildAsync(ulong guildId)

Parameters

guildId ulong

Returns

Task

LoginAsync(LoginRequestJson)

Login with a user account.

public Task<Login> LoginAsync(LoginRequestJson data)

Parameters

data LoginRequestJson

Returns

Task<Login>

LoginMfaSmsAsync<TRequest, TResponse>(TRequest)

Login with a SMS code.

public Task LoginMfaSmsAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest
TResponse

LoginMfaTotpAsync<TRequest, TResponse>(TRequest)

Login with a user account that has MFA.

public Task LoginMfaTotpAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest
TResponse

LogoutAsync()

Logout of the current session/auth.

public Task LogoutAsync()

Returns

Task

LogoutSessionsAsync<TRequest>(TRequest)

Logout a specific session for the user account.

public Task LogoutSessionsAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

PatchCurrentUserFavoriteMediaAsync<TRequest>(ulong, TRequest)

Update your favorite media.

public Task<FavoriteMedia> PatchCurrentUserFavoriteMediaAsync<TRequest>(ulong mediaId, TRequest data)

Parameters

mediaId ulong
data TRequest

Returns

Task<FavoriteMedia>

Type Parameters

TRequest

PatchCurrentUserGuildSettingsAsync<TRequest, TResponse>(ulong, TRequest) 

public Task<TResponse> PatchCurrentUserGuildSettingsAsync<TRequest, TResponse>(ulong guildId, TRequest data)

Parameters

guildId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PatchCurrentUserGuildSettingsSelfAsync<TRequest, TResponse>(TRequest) 

public Task<TResponse> PatchCurrentUserGuildSettingsSelfAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PatchCurrentUserMfaWebauthnCredentialAsync<TRequest, TResponse>(ulong, TRequest)

Update webauthn MFA for current user.

public Task<TResponse> PatchCurrentUserMfaWebauthnCredentialAsync<TRequest, TResponse>(ulong credentialId, TRequest data)

Parameters

credentialId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

User account only.

PinMessageAsync(ulong, ulong)

Pin a message in a channel.

public Task PinMessageAsync(ulong channelId, ulong messageId)

Parameters

channelId ulong
messageId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

PostAuthAuthorizeIpAsync<TRequest>(TRequest)

Authorize and IP for the user account.

public Task PostAuthAuthorizeIpAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

PostAuthLoginMfaWebauthnAsync<TRequest, TResponse>(TRequest)

Setup webauth for the user account.

public Task<TResponse> PostAuthLoginMfaWebauthnAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostAuthLoginMfaWebauthnAuthenticationOptionsAsync<TResponse>()

Setup webauth for the user account.

public Task<TResponse> PostAuthLoginMfaWebauthnAuthenticationOptionsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

PostAuthWebauthnAuthenticateAsync<TRequest, TResponse>(TRequest)

Setup webauth for the user account.

public Task<TResponse> PostAuthWebauthnAuthenticateAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostAuthWebauthnAuthenticationOptionsAsync<TResponse>()

Setup webauth for the user account.

public Task<TResponse> PostAuthWebauthnAuthenticationOptionsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

PostCurrentUserChannelAsync<TRequest, TResponse>(TRequest) 

public Task<TResponse> PostCurrentUserChannelAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostCurrentUserDeleteAsync<TRequest>(TRequest) 

public Task PostCurrentUserDeleteAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

PostCurrentUserDisableAsync<TRequest>(TRequest) 

public Task PostCurrentUserDisableAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

PostCurrentUserFavoriteMediaAsync<TRequest>(TRequest)

Add a favorite media.

public Task<FavoriteMedia> PostCurrentUserFavoriteMediaAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task<FavoriteMedia>

Type Parameters

TRequest

PostCurrentUserHarvestAsync<TRequest, TResponse>(TRequest) 

public Task<TResponse> PostCurrentUserHarvestAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostCurrentUserMessagesDeleteAsync<TRequest>(TRequest) 

public Task PostCurrentUserMessagesDeleteAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

PostCurrentUserMfaBackupCodesAsync<TRequest, TResponse>(TRequest)

Get/create MFA backup codes for current user.

public Task<TResponse> PostCurrentUserMfaBackupCodesAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

User account only.

PostCurrentUserMfaSmsDisableAsync<TRequest>(TRequest)

Disable MFA SMS for current user.

public Task PostCurrentUserMfaSmsDisableAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

Remarks

User account only.

PostCurrentUserMfaSmsEnableAsync<TRequest>(TRequest)

Enable MFA SMS for current user.

public Task PostCurrentUserMfaSmsEnableAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

Remarks

User account only.

PostCurrentUserMfaTotpDisableAsync<TRequest>(TRequest)

Disable MFA for current user.

public Task PostCurrentUserMfaTotpDisableAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

Remarks

User account only.

PostCurrentUserMfaTotpEnableAsync<TRequest, TResponse>(TRequest)

Enable MFA for current user.

public Task<TResponse> PostCurrentUserMfaTotpEnableAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

User account only.

PostCurrentUserMfaWebauthnCredentialsAsync<TRequest, TResponse>(TRequest)

Set webauthn MFA for current user.

public Task<TResponse> PostCurrentUserMfaWebauthnCredentialsAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

User account only.

PostCurrentUserMfaWebauthnCredentialsRegistrationOptionsAsync<TResponse>()

Register webauthn for current user.

public Task<TResponse> PostCurrentUserMfaWebauthnCredentialsRegistrationOptionsAsync<TResponse>()

Returns

Task<TResponse>

Type Parameters

TResponse

Remarks

User account only.

PostCurrentUserPhoneAsync<TRequest, TResponse>(TRequest)

Set phone number for current user.

public Task<TResponse> PostCurrentUserPhoneAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

User account only.

PostCurrentUserPhoneSendVerificationAsync<TRequest>(TRequest)

Send phone verification for current user.

public Task PostCurrentUserPhoneSendVerificationAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

Remarks

User account only.

PostCurrentUserPhoneVerifyAsync<TRequest, TResponse>(TRequest)

Verify phone verification for current user.

public Task<TResponse> PostCurrentUserPhoneVerifyAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

User account only.

PostCurrentUserPreloadMessagesAsync<TRequest>(TRequest) 

public Task PostCurrentUserPreloadMessagesAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

PostCurrentUserPushSubscribeAsync<TRequest, TResponse>(TRequest) 

public Task<TResponse> PostCurrentUserPushSubscribeAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostCurrentUserRelationshipAsync<TRequest, TResponse>(TRequest) 

public Task<TResponse> PostCurrentUserRelationshipAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostCurrentUserRelationshipWithUserAsync<TRequest, TResponse>(ulong, TRequest) 

public Task<TResponse> PostCurrentUserRelationshipWithUserAsync<TRequest, TResponse>(ulong userId, TRequest data)

Parameters

userId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostCurrentUserSavedMessageAsync<TRequest, TResponse>(TRequest) 

public Task<TResponse> PostCurrentUserSavedMessageAsync<TRequest, TResponse>(TRequest data)

Parameters

data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PostReadStatesAckBulkAsync<TRequest>(TRequest)

Clear read message stats for guilds or channels.

public Task PostReadStatesAckBulkAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

Remarks

User account only.

PutCurrentUserChannelPinAsync(ulong) 

public Task PutCurrentUserChannelPinAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task

PutCurrentUserNoteAsync<TRequest, TResponse>(ulong, TRequest)

Add/update current user note for target user.

public Task<TResponse> PutCurrentUserNoteAsync<TRequest, TResponse>(ulong targetId, TRequest data)

Parameters

targetId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

PutCurrentUserRelationshipAsync<TRequest>(ulong, TRequest) 

public Task PutCurrentUserRelationshipAsync<TRequest>(ulong userId, TRequest data)

Parameters

userId ulong
data TRequest

Returns

Task

Type Parameters

TRequest

RegisterAsync<TRequest>(TRequest)

Create a user account

public Task RegisterAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

RemoveAllReactionsAsync(ulong, ulong)

Remove all reactions on a message.

public Task RemoveAllReactionsAsync(ulong channelId, ulong messageId)

Parameters

channelId ulong
messageId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveAllReactionsForEmojiAsync(ulong, ulong, string)

Remove all reactions for a specific emoji on a message.

public Task RemoveAllReactionsForEmojiAsync(ulong channelId, ulong messageId, string emoji)

Parameters

channelId ulong
messageId ulong
emoji string

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

RemoveMemberRoleAsync(ulong, ulong, ulong)

Remove role from a member in the guild.

public Task RemoveMemberRoleAsync(ulong guildId, ulong userId, ulong roleId)

Parameters

guildId ulong
userId ulong
roleId ulong

Returns

Task

Remarks

Requires ManageRoles.

RemoveOwnReactionAsync(ulong, ulong, string)

Remove a reaction on a message.

public Task RemoveOwnReactionAsync(ulong channelId, ulong messageId, string emoji)

Parameters

channelId ulong
messageId ulong
emoji string

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

RemoveRecipientAsync(ulong, ulong)

Remove a user from the group channel.

public Task RemoveRecipientAsync(ulong channelId, ulong userId)

Parameters

channelId ulong
userId ulong

Returns

Task

Remarks

User account only.

RemoveUserReactionAsync(ulong, ulong, string, ulong)

Remove a user's reaction on a message.

public Task RemoveUserReactionAsync(ulong channelId, ulong messageId, string emoji, ulong targetId)

Parameters

channelId ulong
messageId ulong
emoji string
targetId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and ManageMessages in a guild channel.

ResendVerificationEmailAsync()

Send an email verification for the user account.

public Task ResendVerificationEmailAsync()

Returns

Task

ResetPasswordAsync<TRequest>(TRequest)

Reset the password for the user account.

public Task ResetPasswordAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest

RevokeOAuthAccessTokenAsync(ulong, string, string)

Remove access for access token.

public Task RevokeOAuthAccessTokenAsync(ulong clientId, string clientSecret, string accessToken)

Parameters

clientId ulong
clientSecret string
accessToken string

Returns

Task

RevokeOAuthRefreshTokenAsync(ulong, string, string)

Remove access for refresh token.

public Task RevokeOAuthRefreshTokenAsync(ulong clientId, string clientSecret, string refreshToken)

Parameters

clientId ulong
clientSecret string
refreshToken string

Returns

Task

RingCallAsync(ulong, ulong[])

Voice call users.

public Task RingCallAsync(ulong channelId, ulong[] recipients)

Parameters

channelId ulong
recipients ulong[]

Returns

Task

Remarks

User account only.

SearchAuditLogAsync(ulong, GuildAuditLogListRequest)

Search audit logs in the guild.

public Task<GuildAuditLogListJson> SearchAuditLogAsync(ulong guildId, GuildAuditLogListRequest data)

Parameters

guildId ulong
data GuildAuditLogListRequest

Returns

Task<GuildAuditLogListJson>

Remarks

Requires ViewAuditLog.

SearchChannelAsync<TRequest, TResponse>(ulong, TRequest)

Search messages in a channel.

public Task<TResponse> SearchChannelAsync<TRequest, TResponse>(ulong channelId, TRequest data)

Parameters

channelId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

Remarks

Not implemented or tested properly.

SearchChannelMessagesAsync(ulong, GlobalSearchMessagesRequest)

Search messages globally using either guild or channel.

public Task<GlobalSearch> SearchChannelMessagesAsync(ulong channelId, GlobalSearchMessagesRequest request)

Parameters

channelId ulong
request GlobalSearchMessagesRequest

Returns

Task<GlobalSearch>

Remarks

Page needs to be 1 and message scope should not be changed when using bots.

SearchGuildAsync<TRequest, TResponse>(ulong, TRequest)

Search the guild.

public Task<TResponse> SearchGuildAsync<TRequest, TResponse>(ulong guildId, TRequest data)

Parameters

guildId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

SearchGuildChannelMessagesAsync(ulong, ulong, GlobalSearchMessagesRequest)

Search messages globally using either guild or channel.

public Task<GlobalSearch> SearchGuildChannelMessagesAsync(ulong guildId, ulong channelId, GlobalSearchMessagesRequest request)

Parameters

guildId ulong
channelId ulong
request GlobalSearchMessagesRequest

Returns

Task<GlobalSearch>

Remarks

Page needs to be 1 and message scope should not be changed when using bots.

SearchGuildMessagesAsync(ulong, GlobalSearchMessagesRequest)

Search messages globally using either guild or channel.

public Task<GlobalSearch> SearchGuildMessagesAsync(ulong guildId, GlobalSearchMessagesRequest request)

Parameters

guildId ulong
request GlobalSearchMessagesRequest

Returns

Task<GlobalSearch>

Remarks

Page needs to be 1 and message scope should not be changed when using bots.

SearchKlipyAsync(string)

Search klipy gifs.

public Task<IEnumerable<Gif>> SearchKlipyAsync(string query)

Parameters

query string

Returns

Task<IEnumerable<Gif>>

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

Send a message in the channel.

public Task<Message> SendMessageAsync(ulong channelId, 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

channelId ulong
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.

SendMfaSmsCodeAsync()

Send a SMS code.

public Task SendMfaSmsCodeAsync()

Returns

Task

SetCustomStatusAsync(UserCustomStatusJson)

Set current user status.

public Task<UserSettings> SetCustomStatusAsync(UserCustomStatusJson status)

Parameters

status UserCustomStatusJson

Returns

Task<UserSettings>

StopRingingAsync(ulong)

Stop voice calling user.

public Task StopRingingAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task

Remarks

User account only.

TransferOwnershipAsync(ulong, GuildTransferOwnershipRequest)

Change ownership of a guild to another member.

public Task<Guild> TransferOwnershipAsync(ulong guildId, GuildTransferOwnershipRequest data)

Parameters

guildId ulong
data GuildTransferOwnershipRequest

Returns

Task<Guild>

Remarks

Requires guild ownership and user account only.

TriggerTypingIndicatorAsync(ulong)

Send a user typing status for the channel.

public Task TriggerTypingIndicatorAsync(ulong channelId)

Parameters

channelId ulong

Returns

Task

Remarks

Requires ViewChannel in a guild channel.

UnbanMemberAsync(ulong, ulong)

Unban a user from the guild.

public Task UnbanMemberAsync(ulong guildId, ulong userId)

Parameters

guildId ulong
userId ulong

Returns

Task

Remarks

Requires BanMembers.

UnpinMessageAsync(ulong, ulong)

Remove a pinned message in a channel.

public Task UnpinMessageAsync(ulong channelId, ulong messageId)

Parameters

channelId ulong
messageId ulong

Returns

Task

Remarks

Requires ViewChannel, ReadMessageHistory and PinMessages in a guild channel.

UpdateChannelAsync(ulong, ChannelJson)

Modify a channel.

public Task<Channel> UpdateChannelAsync(ulong channelId, ChannelJson channel)

Parameters

channelId ulong
channel ChannelJson

Returns

Task<Channel>

Remarks

Requires ManageChannels for guild channels.

UpdateChannelPositionsAsync(ulong, IEnumerable<ChannelPositionUpdateRequestItem>)

Update channel positions in a guild.

public Task UpdateChannelPositionsAsync(ulong guildId, IEnumerable<ChannelPositionUpdateRequestItem> list)

Parameters

guildId ulong
list IEnumerable<ChannelPositionUpdateRequestItem>

Returns

Task

Remarks

Requires ManageChannels.

UpdateCurrentMemberAsync(ulong, GuildMemberJson)

Update current member in a guild.

public Task<GuildMember> UpdateCurrentMemberAsync(ulong guildId, GuildMemberJson member)

Parameters

guildId ulong
member GuildMemberJson

Returns

Task<GuildMember>

Remarks

Requires ChangeNickname to change your nickname.

UpdateCurrentUserAsync(UserJson)

Update the current user.

public Task<CurrentUser> UpdateCurrentUserAsync(UserJson user)

Parameters

user UserJson

Returns

Task<CurrentUser>

UpdateCurrentUserSettingsAsync<TRequest>(TRequest)

Update current user settings.

public Task<UserSettings> UpdateCurrentUserSettingsAsync<TRequest>(TRequest settings)

Parameters

settings TRequest

Returns

Task<UserSettings>

Type Parameters

TRequest

Remarks

User account only.

UpdateEmojiAsync(ulong, ulong, UpdateGuildEmojiRequest)

Update an emoji in the guild.

public Task<GuildEmoji> UpdateEmojiAsync(ulong guildId, ulong emojiId, UpdateGuildEmojiRequest data)

Parameters

guildId ulong
emojiId ulong
data UpdateGuildEmojiRequest

Returns

Task<GuildEmoji>

Remarks

Requires either CreateExpressions or ManageExpressions.

UpdateGuildAsync(ulong, GuildJson)

Update a guild that you manage.

public Task<Guild> UpdateGuildAsync(ulong guildId, GuildJson guild)

Parameters

guildId ulong
guild GuildJson

Returns

Task<Guild>

Remarks

Requires ManageGuild.

UpdateGuildVanityUrlAsync(ulong, UpdateGuildVanityUrlRequest)

Update vanity url for a guild.

public Task UpdateGuildVanityUrlAsync(ulong guildId, UpdateGuildVanityUrlRequest data)

Parameters

guildId ulong
data UpdateGuildVanityUrlRequest

Returns

Task

Remarks

Requires ManageGuild.

UpdateMemberAsync(ulong, ulong, GuildMemberJson)

Update a member in a guild.

public Task<GuildMember> UpdateMemberAsync(ulong guildId, ulong userId, GuildMemberJson member)

Parameters

guildId ulong
userId ulong
member GuildMemberJson

Returns

Task<GuildMember>

Remarks

Requires either ManageNicknames, DeafenMembers, ManageRoles, ModerateMembers or MuteMembers depending on property.

UpdateRoleAsync(ulong, ulong, UpdateGuildRoleRequest)

Update a role in the guild.

public Task<Role> UpdateRoleAsync(ulong guildId, ulong roleId, UpdateGuildRoleRequest data)

Parameters

guildId ulong
roleId ulong
data UpdateGuildRoleRequest

Returns

Task<Role>

Remarks

Requires ManageRoles.

UpdateRolePositionsAsync(ulong, IEnumerable<RolePositionItemJson>)

Update role positions in the guild.

public Task UpdateRolePositionsAsync(ulong guildId, IEnumerable<RolePositionItemJson> positions)

Parameters

guildId ulong
positions IEnumerable<RolePositionItemJson>

Returns

Task

Remarks

Requires ManageRoles.

UpdateStickerAsync(ulong, ulong, UpdateGuildStickerRequest)

Update a sticker in the guild.

public Task<GuildSticker> UpdateStickerAsync(ulong guildId, ulong stickerId, UpdateGuildStickerRequest data)

Parameters

guildId ulong
stickerId ulong
data UpdateGuildStickerRequest

Returns

Task<GuildSticker>

Remarks

Requires either CreateExpressions or ManageExpressions.

UpdateVoiceRegionAsync(ulong, string?)

Update the voice region for a voice channel.

public Task UpdateVoiceRegionAsync(ulong channelId, string? region)

Parameters

channelId ulong
region string

Returns

Task

Remarks

Requires ViewChannel and UpdateRtcRegion in a guild channel.

UpdateWebhookAsync<TRequest>(ulong, TRequest)

Update webhook in a guild channel.

public Task<Webhook> UpdateWebhookAsync<TRequest>(ulong webhookId, TRequest data)

Parameters

webhookId ulong
data TRequest

Returns

Task<Webhook>

Type Parameters

TRequest

Remarks

Requires ManageWebhooks.

UpdateWebhookWithTokenAsync<TRequest>(ulong, string, TRequest)

Update webhook using the webhook token.

public Task<Webhook> UpdateWebhookWithTokenAsync<TRequest>(ulong webhookId, string token, TRequest data)

Parameters

webhookId ulong
token string
data TRequest

Returns

Task<Webhook>

Type Parameters

TRequest

UploadAttachmentsAsync<TRequest, TResponse>(ulong, TRequest)

Upload multiple attachments to a channel.

public Task<TResponse> UploadAttachmentsAsync<TRequest, TResponse>(ulong channelId, TRequest data)

Parameters

channelId ulong
data TRequest

Returns

Task<TResponse>

Type Parameters

TRequest
TResponse

VerifyEmailAsync<TRequest>(TRequest)

Verify the user account email.

public Task VerifyEmailAsync<TRequest>(TRequest data)

Parameters

data TRequest

Returns

Task

Type Parameters

TRequest
Edit this page