Class GuildHelpers

Namespace

Fluxer.Net

Assembly

Fluxer.Net.dll

Http methods for Guild class.

public static class GuildHelpers

Inheritance

object

GuildHelpers

Methods

BanUserAsync(Guild, User, string?, int?, int?, RequestOptions?)

Ban a member from the guild.

public static Task BanUserAsync(this Guild guild, User user, string? reason = null, int? deleteMessageSeconds = null, int? banDurationSeconds = null, RequestOptions? options = null)

Parameters

guild Guild

user User

reason string

deleteMessageSeconds int?

banDurationSeconds int?

options RequestOptions

Returns

Task

Remarks

Requires BanMembers.

BanUserAsync(Guild, ulong, string?, int?, int?, RequestOptions?)

Ban a member from the guild.

public static Task BanUserAsync(this Guild guild, ulong userId, string? reason = null, int? deleteMessageSeconds = null, int? banDurationSeconds = null, RequestOptions? options = null)

Parameters

guild Guild

userId ulong

reason string

deleteMessageSeconds int?

banDurationSeconds int?

options RequestOptions

Returns

Task

Remarks

Requires BanMembers.

CreateCategoryChannelAsync(Guild, CreateCategoryChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<CategoryChannel> CreateCategoryChannelAsync(this Guild guild, CreateCategoryChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateCategoryChannelRequest

options RequestOptions

Returns

Task<CategoryChannel>

Channel

Remarks

Requires ManageChannels.

CreateEmojiAsync(Guild, CreateGuildEmojiRequest, RequestOptions?)

Create emojis for the guild.

public static Task<GuildEmoji> CreateEmojiAsync(this Guild guild, CreateGuildEmojiRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateGuildEmojiRequest

options RequestOptions

Returns

Task<GuildEmoji>

GuildEmoji

Remarks

Requires either CreateExpressions or ManageExpressions.

CreateForumChannelAsync(Guild, CreateForumChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<ForumChannel> CreateForumChannelAsync(this Guild guild, CreateForumChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateForumChannelRequest

options RequestOptions

Returns

Task<ForumChannel>

Channel

Remarks

Requires ManageChannels.

CreateLinkChannelAsync(Guild, CreateLinkChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<LinkChannel> CreateLinkChannelAsync(this Guild guild, CreateLinkChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateLinkChannelRequest

options RequestOptions

Returns

Task<LinkChannel>

Channel

Remarks

Requires ManageChannels.

CreateMediaChannelAsync(Guild, CreateMediaChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<MediaChannel> CreateMediaChannelAsync(this Guild guild, CreateMediaChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateMediaChannelRequest

options RequestOptions

Returns

Task<MediaChannel>

Channel

Remarks

Requires ManageChannels.

CreateNewsChannelAsync(Guild, CreateNewsChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<NewsChannel> CreateNewsChannelAsync(this Guild guild, CreateNewsChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateNewsChannelRequest

options RequestOptions

Returns

Task<NewsChannel>

Channel

Remarks

Requires ManageChannels.

CreateRoleAsync(Guild, CreateGuildRoleRequest, RequestOptions?)

Create a role in the guild.

public static Task<Role> CreateRoleAsync(this Guild guild, CreateGuildRoleRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateGuildRoleRequest

options RequestOptions

Returns

Task<Role>

Role

Remarks

Requires ManageRoles.

CreateStickerAsync(Guild, CreateGuildStickerRequest, RequestOptions?)

Create stickers for a guild.

public static Task<GuildSticker> CreateStickerAsync(this Guild guild, CreateGuildStickerRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateGuildStickerRequest

options RequestOptions

Returns

Task<GuildSticker>

GuildSticker

Remarks

Requires either CreateExpressions or ManageExpressions.

CreateTextChannelAsync(Guild, CreateTextChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<TextChannel> CreateTextChannelAsync(this Guild guild, CreateTextChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateTextChannelRequest

options RequestOptions

Returns

Task<TextChannel>

Channel

Remarks

Requires ManageChannels.

CreateVoiceChannelAsync(Guild, CreateVoiceChannelRequest, RequestOptions?)

Create a channel in the guild.

public static Task<VoiceChannel> CreateVoiceChannelAsync(this Guild guild, CreateVoiceChannelRequest request, RequestOptions? options = null)

Parameters

guild Guild

request CreateVoiceChannelRequest

options RequestOptions

Returns

Task<VoiceChannel>

Channel

Remarks

Requires ManageChannels.

GetAuditLogsAsync(Guild, GuildAuditLogListRequest, RequestOptions?)

Search audit logs in the guild.

public static Task<AuditLogListJson> GetAuditLogsAsync(this Guild guild, GuildAuditLogListRequest request, RequestOptions? options = null)

Parameters

guild Guild

request GuildAuditLogListRequest

options RequestOptions

Returns

Task<AuditLogListJson>

Fluxer.Net.AuditLogListJson

Remarks

Requires ViewAuditLog.

GetBansAsync(Guild, RequestOptions?)

Get bans for a guild.

public static Task<IEnumerable<GuildBan>> GetBansAsync(this Guild guild, RequestOptions? options = null)

Parameters

guild Guild

options RequestOptions

Returns

Task<IEnumerable<GuildBan>>

List of GuildBan

Remarks

Requires BanMembers.

GetChannelsAsync(Guild, RequestOptions?)

Get all channels in the guild.

public static Task<IEnumerable<Channel>> GetChannelsAsync(this Guild guild, RequestOptions? options = null)

Parameters

guild Guild

options RequestOptions

Returns

Task<IEnumerable<Channel>>

List of Channel

Remarks

Requires ViewChannel.

GetEmojisAsync(Guild, RequestOptions?)

Get all emojis in the guild.

public static Task<IEnumerable<GuildEmoji>> GetEmojisAsync(this Guild guild, RequestOptions? options = null)

Parameters

guild Guild

options RequestOptions

Returns

Task<IEnumerable<GuildEmoji>>

List of GuildEmoji

Remarks

Requires either CreateExpressions or ManageExpressions.

GetInvitesAsync(Guild, RequestOptions?)

Get all invites for the guild.

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

Parameters

guild Guild

options RequestOptions

Returns

Task<IEnumerable<Invite>>

List of Invite

Remarks

Requires ManageChannel.

GetMemberAsync(Guild, User, RequestOptions?)

Get a member in a guild.

public static Task<GuildMember?> GetMemberAsync(this Guild guild, User user, RequestOptions? options = null)

Parameters

guild Guild

user User

options RequestOptions

Returns

Task<GuildMember>

GuildMember

GetMemberAsync(Guild, ulong, RequestOptions?)

Get a member in a guild.

public static Task<GuildMember?> GetMemberAsync(this Guild guild, ulong userId, RequestOptions? options = null)

Parameters

guild Guild

userId ulong

options RequestOptions

Returns

Task<GuildMember>

GuildMember

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

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

public static Task<IEnumerable<GuildMember>> GetMembersAsync(this Guild guild, int limit = 1000, ulong? afterId = null, RestClientQueryParams? queryParams = null, RequestOptions? options = null)

Parameters

guild Guild

limit int

afterId ulong?

queryParams RestClientQueryParams

options RequestOptions

Returns

Task<IEnumerable<GuildMember>>

List of GuildMember

GetStickersAsync(Guild, RequestOptions?)

Get all stickers in the guild.

public static Task GetStickersAsync(this Guild guild, RequestOptions? options = null)

Parameters

guild Guild

options RequestOptions

Returns

Task

List of GuildSticker

Remarks

Requires either CreateExpressions or ManageExpressions.

GetThreadChannelAsync(Guild, ulong, RequestOptions?)

Get a channel.

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

Parameters

guild Guild

threadId ulong

options RequestOptions

Returns

Task<ThreadChannel>

Channel

Remarks

Requires ViewChannel for guild channels.

GetVanityUrlAsync(Guild, RequestOptions?)

Get vanity url for a guild.

public static Task<GuildVanityUrl> GetVanityUrlAsync(this Guild guild, RequestOptions? options = null)

Parameters

guild Guild

options RequestOptions

Returns

Task<GuildVanityUrl>

GuildVanityUrl

GetWebhookAsync(Guild, ulong, RequestOptions?)

Get all webhooks for the guild.

public static Task<Webhook?> GetWebhookAsync(this Guild guild, ulong webhookId, RequestOptions? options = null)

Parameters

guild Guild

webhookId ulong

options RequestOptions

Returns

Task<Webhook>

List of Webhook

Remarks

Requires ManageWebhooks.

GetWebhooksAsync(Guild, RequestOptions?)

Get all webhooks for the guild.

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

Parameters

guild Guild

options RequestOptions

Returns

Task<IEnumerable<Webhook>>

List of Webhook

Remarks

Requires ManageWebhooks.

KickUserAsync(Guild, User, string?, RequestOptions?)

Kick a member from the guild.

public static Task KickUserAsync(this Guild guild, User user, string? reason = null, RequestOptions? options = null)

Parameters

guild Guild

user User

reason string

options RequestOptions

Returns

Task

Remarks

Requires KickMembers.

KickUserAsync(Guild, ulong, string?, RequestOptions?)

Kick a member from the guild.

public static Task KickUserAsync(this Guild guild, ulong userId, string? reason = null, RequestOptions? options = null)

Parameters

guild Guild

userId ulong

reason string

options RequestOptions

Returns

Task

Remarks

Requires KickMembers.

LeaveAsync(Guild, RequestOptions?)

Leave a guild for the current user.

public static Task LeaveAsync(this Guild guild, RequestOptions? options = null)

Parameters

guild Guild

options RequestOptions

Returns

Task

ModifyAsync(Guild, GuildJson, RequestOptions?)

Update a guild that you manage.

public static Task<Guild> ModifyAsync(this Guild guild, GuildJson request, RequestOptions? options = null)

Parameters

guild Guild

request GuildJson

options RequestOptions

Returns

Task<Guild>

Guild

Remarks

Requires ManageGuild.

UnbanUserAsync(Guild, User, RequestOptions?)

Unban a user from the guild.

public static Task UnbanUserAsync(this Guild guild, User user, RequestOptions? options = null)

Parameters

guild Guild

user User

options RequestOptions

Returns

Task

Remarks

Requires BanMembers.

UnbanUserAsync(Guild, ulong, RequestOptions?)

Unban a user from the guild.

public static Task UnbanUserAsync(this Guild guild, ulong userId, RequestOptions? options = null)

Parameters

guild Guild

userId ulong

options RequestOptions

Returns

Task

Remarks

Requires BanMembers.

UpdateChannelPositionsAsync(Guild, IEnumerable<ChannelPositionUpdateRequestItem>, RequestOptions?)

Update channel positions in a guild.

public static Task UpdateChannelPositionsAsync(this Guild guild, IEnumerable<ChannelPositionUpdateRequestItem> list, RequestOptions? options = null)

Parameters

guild Guild

list IEnumerable<ChannelPositionUpdateRequestItem>

options RequestOptions

Returns

Task

Remarks

Requires ManageChannels.