Class SocketGuild

Represents a WebSocket-based guild object.

Inheritance
System.Object
SocketEntity<System.UInt64>
SocketGuild
Implements
IEntity<System.UInt64>
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Discord.WebSocket
Assembly: Discord.Net.WebSocket.dll
Syntax
public class SocketGuild : SocketEntity<ulong>, IGuild, IDeletable, ISnowflakeEntity, IEntity<ulong>, IDisposable

Properties

| Improve this Doc View Source

AFKChannel

Gets the AFK voice channel in this guild.

Declaration
public SocketVoiceChannel AFKChannel { get; }
Property Value
Type Description
SocketVoiceChannel

A SocketVoiceChannel that the AFK users will be moved to after they have idled for too long; null if none is set.
| Improve this Doc View Source

AFKTimeout

Declaration
public int AFKTimeout { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ApplicationId

Declaration
public ulong? ApplicationId { get; }
Property Value
Type Description
System.Nullable<System.UInt64>
| Improve this Doc View Source

AudioClient

Gets the IAudioClient associated with this guild.

Declaration
public IAudioClient AudioClient { get; }
Property Value
Type Description
IAudioClient
| Improve this Doc View Source

BannerId

Declaration
public string BannerId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

BannerUrl

Declaration
public string BannerUrl { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CategoryChannels

Gets a collection of all category channels in this guild.

Declaration
public IReadOnlyCollection<SocketCategoryChannel> CategoryChannels { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketCategoryChannel>

A read-only collection of category channels found within this guild.
| Improve this Doc View Source

Channels

Gets a collection of all channels in this guild.

Declaration
public IReadOnlyCollection<SocketGuildChannel> Channels { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketGuildChannel>

A read-only collection of generic channels found within this guild.
| Improve this Doc View Source

CreatedAt

Declaration
public DateTimeOffset CreatedAt { get; }
Property Value
Type Description
System.DateTimeOffset
| Improve this Doc View Source

CurrentUser

Gets the current logged-in user.

Declaration
public SocketGuildUser CurrentUser { get; }
Property Value
Type Description
SocketGuildUser
| Improve this Doc View Source

DefaultChannel

Gets the default channel in this guild.

Declaration
public SocketTextChannel DefaultChannel { get; }
Property Value
Type Description
SocketTextChannel

A SocketTextChannel representing the first viewable channel that the user has access to.
Remarks

This property retrieves the first viewable text channel for this guild.

warning

This channel does not guarantee the user can send message to it, as it only looks for the first viewable text channel.

| Improve this Doc View Source

DefaultMessageNotifications

Declaration
public DefaultMessageNotifications DefaultMessageNotifications { get; }
Property Value
Type Description
DefaultMessageNotifications
| Improve this Doc View Source

Description

Declaration
public string Description { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DownloadedMemberCount

Gets the number of members downloaded to the local guild cache.

Declaration
public int DownloadedMemberCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DownloaderPromise

Declaration
public Task DownloaderPromise { get; }
Property Value
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

EmbedChannel

Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild.

Declaration
public SocketGuildChannel EmbedChannel { get; }
Property Value
Type Description
SocketGuildChannel

A channel set within the server's widget settings; null if none is set.
| Improve this Doc View Source

Emotes

Declaration
public IReadOnlyCollection<GuildEmote> Emotes { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<GuildEmote>
| Improve this Doc View Source

EveryoneRole

Gets the built-in role containing all users in this guild.

Declaration
public SocketRole EveryoneRole { get; }
Property Value
Type Description
SocketRole

A role object that represents an @everyone role in this guild.
| Improve this Doc View Source

ExplicitContentFilter

Declaration
public ExplicitContentFilterLevel ExplicitContentFilter { get; }
Property Value
Type Description
ExplicitContentFilterLevel
| Improve this Doc View Source

Features

Declaration
public IReadOnlyCollection<string> Features { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<System.String>
| Improve this Doc View Source

HasAllMembers

Indicates whether the client has all the members downloaded to the local guild cache.

Declaration
public bool HasAllMembers { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IconId

Declaration
public string IconId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IconUrl

Declaration
public string IconUrl { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsConnected

Indicates whether the client is connected to this guild.

Declaration
public bool IsConnected { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsEmbeddable

Declaration
public bool IsEmbeddable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsSynced

Indicates whether the guild cache is synced to this guild.

Declaration
public bool IsSynced { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MemberCount

Gets the number of members.

Declaration
public int MemberCount { get; }
Property Value
Type Description
System.Int32
Remarks

This property retrieves the number of members returned by Discord.

tip

Due to how this property is returned by Discord instead of relying on the WebSocket cache, the number here is the most accurate in terms of counting the number of users within this guild.

Use this instead of enumerating the count of the Users collection, as you may see discrepancy between that and this property.

| Improve this Doc View Source

MfaLevel

Declaration
public MfaLevel MfaLevel { get; }
Property Value
Type Description
MfaLevel
| Improve this Doc View Source

Name

Declaration
public string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Owner

Gets the user that owns this guild.

Declaration
public SocketGuildUser Owner { get; }
Property Value
Type Description
SocketGuildUser
| Improve this Doc View Source

OwnerId

Declaration
public ulong OwnerId { get; }
Property Value
Type Description
System.UInt64
| Improve this Doc View Source

PreferredCulture

Declaration
public CultureInfo PreferredCulture { get; }
Property Value
Type Description
System.Globalization.CultureInfo
| Improve this Doc View Source

PreferredLocale

Declaration
public string PreferredLocale { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PremiumSubscriptionCount

Declaration
public int PremiumSubscriptionCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PremiumTier

Declaration
public PremiumTier PremiumTier { get; }
Property Value
Type Description
PremiumTier
| Improve this Doc View Source

Roles

Gets a collection of all roles in this guild.

Declaration
public IReadOnlyCollection<SocketRole> Roles { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketRole>

A read-only collection of roles found within this guild.
| Improve this Doc View Source

SplashId

Declaration
public string SplashId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SplashUrl

Declaration
public string SplashUrl { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SyncPromise

Declaration
public Task SyncPromise { get; }
Property Value
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SystemChannel

Gets the system channel where randomized welcome messages are sent in this guild.

Declaration
public SocketTextChannel SystemChannel { get; }
Property Value
Type Description
SocketTextChannel

A text channel where randomized welcome messages will be sent to; null if none is set.
| Improve this Doc View Source

SystemChannelFlags

Declaration
public SystemChannelMessageDeny SystemChannelFlags { get; }
Property Value
Type Description
SystemChannelMessageDeny
| Improve this Doc View Source

TextChannels

Gets a collection of all text channels in this guild.

Declaration
public IReadOnlyCollection<SocketTextChannel> TextChannels { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketTextChannel>

A read-only collection of message channels found within this guild.
| Improve this Doc View Source

Users

Gets a collection of users in this guild.

Declaration
public IReadOnlyCollection<SocketGuildUser> Users { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketGuildUser>

A collection of guild users found within this guild.
Remarks

This property retrieves all users found within this guild.

warning

This property may not always return all the members for large guilds (i.e. guilds containing 100+ users). If you are simply looking to get the number of users present in this guild, consider using MemberCount instead.

Otherwise, you may need to enable AlwaysDownloadUsers to fetch the full user list upon startup, or use DownloadUsersAsync() to manually download the users.

| Improve this Doc View Source

VanityURLCode

Declaration
public string VanityURLCode { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

VerificationLevel

Declaration
public VerificationLevel VerificationLevel { get; }
Property Value
Type Description
VerificationLevel
| Improve this Doc View Source

VoiceChannels

Gets a collection of all voice channels in this guild.

Declaration
public IReadOnlyCollection<SocketVoiceChannel> VoiceChannels { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<SocketVoiceChannel>

A read-only collection of voice channels found within this guild.
| Improve this Doc View Source

VoiceRegionId

Declaration
public string VoiceRegionId { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

AddBanAsync(IUser, Int32, String, RequestOptions)

Declaration
public Task AddBanAsync(IUser user, int pruneDays = 0, string reason = null, RequestOptions options = null)
Parameters
Type Name Description
IUser user
System.Int32 pruneDays
System.String reason
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

AddBanAsync(UInt64, Int32, String, RequestOptions)

Declaration
public Task AddBanAsync(ulong userId, int pruneDays = 0, string reason = null, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 userId
System.Int32 pruneDays
System.String reason
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

AddGuildUserAsync(UInt64, String, Action<AddGuildUserProperties>, RequestOptions)

Declaration
public Task<RestGuildUser> AddGuildUserAsync(ulong id, string accessToken, Action<AddGuildUserProperties> func = null, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 id
System.String accessToken
System.Action<AddGuildUserProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<RestGuildUser>
| Improve this Doc View Source

CreateCategoryChannelAsync(String, Action<GuildChannelProperties>, RequestOptions)

Creates a new channel category in this guild.

Declaration
public Task<RestCategoryChannel> CreateCategoryChannelAsync(string name, Action<GuildChannelProperties> func = null, RequestOptions options = null)
Parameters
Type Name Description
System.String name

The new name for the category.
System.Action<GuildChannelProperties> func

The delegate containing the properties to be applied to the channel upon its creation.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestCategoryChannel>

A task that represents the asynchronous creation operation. The task result contains the newly created category channel.
Exceptions
Type Condition
System.ArgumentNullException

name is null.
| Improve this Doc View Source

CreateEmoteAsync(String, Image, Optional<IEnumerable<IRole>>, RequestOptions)

Declaration
public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null)
Parameters
Type Name Description
System.String name
Image image
Optional<System.Collections.Generic.IEnumerable<IRole>> roles
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<GuildEmote>
| Improve this Doc View Source

CreateIntegrationAsync(UInt64, String, RequestOptions)

Declaration
public Task<RestGuildIntegration> CreateIntegrationAsync(ulong id, string type, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 id
System.String type
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<RestGuildIntegration>
| Improve this Doc View Source

CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, RequestOptions)

Declaration
public Task<RestRole> CreateRoleAsync(string name, GuildPermissions? permissions = default(GuildPermissions? ), Color? color = default(Color? ), bool isHoisted = false, RequestOptions options = null)
Parameters
Type Name Description
System.String name
System.Nullable<GuildPermissions> permissions
System.Nullable<Color> color
System.Boolean isHoisted
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<RestRole>
| Improve this Doc View Source

CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, Boolean, RequestOptions)

Creates a new role with the provided name.

Declaration
public Task<RestRole> CreateRoleAsync(string name, GuildPermissions? permissions = default(GuildPermissions? ), Color? color = default(Color? ), bool isHoisted = false, bool isMentionable = false, RequestOptions options = null)
Parameters
Type Name Description
System.String name

The new name for the role.
System.Nullable<GuildPermissions> permissions

The guild permission that the role should possess.
System.Nullable<Color> color

The color of the role.
System.Boolean isHoisted

Whether the role is separated from others on the sidebar.
System.Boolean isMentionable

Whether the role can be mentioned.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestRole>

A task that represents the asynchronous creation operation. The task result contains the newly created role.
Exceptions
Type Condition
System.ArgumentNullException

name is null.
| Improve this Doc View Source

CreateTextChannelAsync(String, Action<TextChannelProperties>, RequestOptions)

Creates a new text channel in this guild.

Declaration
public Task<RestTextChannel> CreateTextChannelAsync(string name, Action<TextChannelProperties> func = null, RequestOptions options = null)
Parameters
Type Name Description
System.String name

The new name for the text channel.
System.Action<TextChannelProperties> func

The delegate containing the properties to be applied to the channel upon its creation.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestTextChannel>

A task that represents the asynchronous creation operation. The task result contains the newly created text channel.
Examples

The following example creates a new text channel under an existing category named Wumpus with a set topic.

var categories = await guild.GetCategoriesAsync();
var targetCategory = categories.FirstOrDefault(x => x.Name == "wumpus");
if (targetCategory == null) return;
await Context.Guild.CreateTextChannelAsync(name, x =>
{
    x.CategoryId = targetCategory.Id;
    x.Topic = $"This channel was created at {DateTimeOffset.UtcNow} by {user}.";
});
| Improve this Doc View Source

CreateVoiceChannelAsync(String, Action<VoiceChannelProperties>, RequestOptions)

Creates a new voice channel in this guild.

Declaration
public Task<RestVoiceChannel> CreateVoiceChannelAsync(string name, Action<VoiceChannelProperties> func = null, RequestOptions options = null)
Parameters
Type Name Description
System.String name

The new name for the voice channel.
System.Action<VoiceChannelProperties> func

The delegate containing the properties to be applied to the channel upon its creation.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestVoiceChannel>

A task that represents the asynchronous creation operation. The task result contains the newly created voice channel.
Exceptions
Type Condition
System.ArgumentNullException

name is null.
| Improve this Doc View Source

DeleteAsync(RequestOptions)

Declaration
public Task DeleteAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

DeleteEmoteAsync(GuildEmote, RequestOptions)

Declaration
public Task DeleteEmoteAsync(GuildEmote emote, RequestOptions options = null)
Parameters
Type Name Description
GuildEmote emote
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

DownloadUsersAsync()

Declaration
public Task DownloadUsersAsync()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

GetAuditLogsAsync(Int32, RequestOptions, Nullable<UInt64>, Nullable<UInt64>, Nullable<ActionType>)

Gets the specified number of audit log entries for this guild.

Declaration
public IAsyncEnumerable<IReadOnlyCollection<RestAuditLogEntry>> GetAuditLogsAsync(int limit, RequestOptions options = null, ulong? beforeId = default(ulong? ), ulong? userId = default(ulong? ), ActionType? actionType = default(ActionType? ))
Parameters
Type Name Description
System.Int32 limit

The number of audit log entries to fetch.
RequestOptions options

The options to be used when sending the request.
System.Nullable<System.UInt64> beforeId

The audit log entry ID to filter entries before.
System.Nullable<System.UInt64> userId

The user ID to filter entries for.
System.Nullable<ActionType> actionType

The type of actions to filter.
Returns
Type Description
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestAuditLogEntry>>

A task that represents the asynchronous get operation. The task result contains a read-only collection of the requested audit log entries.
| Improve this Doc View Source

GetBanAsync(IUser, RequestOptions)

Gets a ban object for a banned user.

Declaration
public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null)
Parameters
Type Name Description
IUser user

The banned user.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestBan>

A task that represents the asynchronous get operation. The task result contains a ban object, which contains the user information and the reason for the ban; null if the ban entry cannot be found.
| Improve this Doc View Source

GetBanAsync(UInt64, RequestOptions)

Gets a ban object for a banned user.

Declaration
public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 userId

The snowflake identifier for the banned user.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestBan>

A task that represents the asynchronous get operation. The task result contains a ban object, which contains the user information and the reason for the ban; null if the ban entry cannot be found.
| Improve this Doc View Source

GetBansAsync(RequestOptions)

Gets a collection of all users banned in this guild.

Declaration
public Task<IReadOnlyCollection<RestBan>> GetBansAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestBan>>

A task that represents the asynchronous get operation. The task result contains a read-only collection of ban objects that this guild currently possesses, with each object containing the user banned and reason behind the ban.
| Improve this Doc View Source

GetCategoryChannel(UInt64)

Gets a category channel in this guild.

Declaration
public SocketCategoryChannel GetCategoryChannel(ulong id)
Parameters
Type Name Description
System.UInt64 id

The snowflake identifier for the category channel.
Returns
Type Description
SocketCategoryChannel

A category channel associated with the specified id; null if none is found.
| Improve this Doc View Source

GetChannel(UInt64)

Gets a channel in this guild.

Declaration
public SocketGuildChannel GetChannel(ulong id)
Parameters
Type Name Description
System.UInt64 id

The snowflake identifier for the channel.
Returns
Type Description
SocketGuildChannel

A generic channel associated with the specified id; null if none is found.
| Improve this Doc View Source

GetEmoteAsync(UInt64, RequestOptions)

Declaration
public Task<GuildEmote> GetEmoteAsync(ulong id, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 id
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<GuildEmote>
| Improve this Doc View Source

GetIntegrationsAsync(RequestOptions)

Declaration
public Task<IReadOnlyCollection<RestGuildIntegration>> GetIntegrationsAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestGuildIntegration>>
| Improve this Doc View Source

GetInvitesAsync(RequestOptions)

Gets a collection of all invites in this guild.

Declaration
public Task<IReadOnlyCollection<RestInviteMetadata>> GetInvitesAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestInviteMetadata>>

A task that represents the asynchronous get operation. The task result contains a read-only collection of invite metadata, each representing information for an invite found within this guild.
| Improve this Doc View Source

GetRole(UInt64)

Gets a role in this guild.

Declaration
public SocketRole GetRole(ulong id)
Parameters
Type Name Description
System.UInt64 id

The snowflake identifier for the role.
Returns
Type Description
SocketRole

A role that is associated with the specified id; null if none is found.
| Improve this Doc View Source

GetTextChannel(UInt64)

Gets a text channel in this guild.

Declaration
public SocketTextChannel GetTextChannel(ulong id)
Parameters
Type Name Description
System.UInt64 id

The snowflake identifier for the text channel.
Returns
Type Description
SocketTextChannel

A text channel associated with the specified id; null if none is found.
| Improve this Doc View Source

GetUser(UInt64)

Gets a user from this guild.

Declaration
public SocketGuildUser GetUser(ulong id)
Parameters
Type Name Description
System.UInt64 id

The snowflake identifier of the user.
Returns
Type Description
SocketGuildUser

A guild user associated with the specified id; null if none is found.
Remarks

This method retrieves a user found within this guild.

note

This may return null in the WebSocket implementation due to incomplete user collection in large guilds.

| Improve this Doc View Source

GetVanityInviteAsync(RequestOptions)

Gets the vanity invite URL of this guild.

Declaration
public Task<RestInviteMetadata> GetVanityInviteAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestInviteMetadata>

A task that represents the asynchronous get operation. The task result contains the partial metadata of the vanity invite found within this guild; null if none is found.
| Improve this Doc View Source

GetVoiceChannel(UInt64)

Gets a voice channel in this guild.

Declaration
public SocketVoiceChannel GetVoiceChannel(ulong id)
Parameters
Type Name Description
System.UInt64 id

The snowflake identifier for the voice channel.
Returns
Type Description
SocketVoiceChannel

A voice channel associated with the specified id; null if none is found.
| Improve this Doc View Source

GetVoiceRegionsAsync(RequestOptions)

Gets a collection of all the voice regions this guild can access.

Declaration
public Task<IReadOnlyCollection<RestVoiceRegion>> GetVoiceRegionsAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestVoiceRegion>>

A task that represents the asynchronous get operation. The task result contains a read-only collection of voice regions the guild can access.
| Improve this Doc View Source

GetWebhookAsync(UInt64, RequestOptions)

Gets a webhook found within this guild.

Declaration
public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 id

The identifier for the webhook.
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<RestWebhook>

A task that represents the asynchronous get operation. The task result contains the webhook with the specified id; null if none is found.
| Improve this Doc View Source

GetWebhooksAsync(RequestOptions)

Gets a collection of all webhook from this guild.

Declaration
public Task<IReadOnlyCollection<RestWebhook>> GetWebhooksAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options

The options to be used when sending the request.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestWebhook>>

A task that represents the asynchronous get operation. The task result contains a read-only collection of webhooks found within the guild.
| Improve this Doc View Source

LeaveAsync(RequestOptions)

Declaration
public Task LeaveAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

ModifyAsync(Action<GuildProperties>, RequestOptions)

Declaration
public Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null)
Parameters
Type Name Description
System.Action<GuildProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.ArgumentNullException

func is null.
| Improve this Doc View Source

ModifyEmbedAsync(Action<GuildEmbedProperties>, RequestOptions)

Declaration
public Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null)
Parameters
Type Name Description
System.Action<GuildEmbedProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
Exceptions
Type Condition
System.ArgumentNullException

func is null.
| Improve this Doc View Source

ModifyEmoteAsync(GuildEmote, Action<EmoteProperties>, RequestOptions)

Declaration
public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null)
Parameters
Type Name Description
GuildEmote emote
System.Action<EmoteProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<GuildEmote>
Exceptions
Type Condition
System.ArgumentNullException

func is null.
| Improve this Doc View Source

PruneUsersAsync(Int32, Boolean, RequestOptions)

Declaration
public Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null)
Parameters
Type Name Description
System.Int32 days
System.Boolean simulate
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

RemoveBanAsync(IUser, RequestOptions)

Declaration
public Task RemoveBanAsync(IUser user, RequestOptions options = null)
Parameters
Type Name Description
IUser user
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

RemoveBanAsync(UInt64, RequestOptions)

Declaration
public Task RemoveBanAsync(ulong userId, RequestOptions options = null)
Parameters
Type Name Description
System.UInt64 userId
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

ReorderChannelsAsync(IEnumerable<ReorderChannelProperties>, RequestOptions)

Declaration
public Task ReorderChannelsAsync(IEnumerable<ReorderChannelProperties> args, RequestOptions options = null)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ReorderChannelProperties> args
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

ReorderRolesAsync(IEnumerable<ReorderRoleProperties>, RequestOptions)

Declaration
public Task ReorderRolesAsync(IEnumerable<ReorderRoleProperties> args, RequestOptions options = null)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ReorderRoleProperties> args
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

ToString()

Gets the name of the guild.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string that resolves to Name.
Overrides
System.Object.ToString()

Explicit Interface Implementations

| Improve this Doc View Source

IGuild.AddGuildUserAsync(UInt64, String, Action<AddGuildUserProperties>, RequestOptions)

Declaration
Task<IGuildUser> IGuild.AddGuildUserAsync(ulong userId, string accessToken, Action<AddGuildUserProperties> func, RequestOptions options)
Parameters
Type Name Description
System.UInt64 userId
System.String accessToken
System.Action<AddGuildUserProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildUser>
| Improve this Doc View Source

IGuild.AFKChannelId

Declaration
ulong? IGuild.AFKChannelId { get; }
Returns
Type Description
System.Nullable<System.UInt64>
| Improve this Doc View Source

IGuild.AudioClient

Declaration
IAudioClient IGuild.AudioClient { get; }
Returns
Type Description
IAudioClient
| Improve this Doc View Source

IGuild.Available

Declaration
bool IGuild.Available { get; }
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IGuild.CreateCategoryAsync(String, Action<GuildChannelProperties>, RequestOptions)

Declaration
Task<ICategoryChannel> IGuild.CreateCategoryAsync(string name, Action<GuildChannelProperties> func, RequestOptions options)
Parameters
Type Name Description
System.String name
System.Action<GuildChannelProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<ICategoryChannel>
| Improve this Doc View Source

IGuild.CreateIntegrationAsync(UInt64, String, RequestOptions)

Declaration
Task<IGuildIntegration> IGuild.CreateIntegrationAsync(ulong id, string type, RequestOptions options)
Parameters
Type Name Description
System.UInt64 id
System.String type
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildIntegration>
| Improve this Doc View Source

IGuild.CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, RequestOptions)

Declaration
Task<IRole> IGuild.CreateRoleAsync(string name, GuildPermissions? permissions, Color? color, bool isHoisted, RequestOptions options)
Parameters
Type Name Description
System.String name
System.Nullable<GuildPermissions> permissions
System.Nullable<Color> color
System.Boolean isHoisted
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IRole>
| Improve this Doc View Source

IGuild.CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, Boolean, RequestOptions)

Declaration
Task<IRole> IGuild.CreateRoleAsync(string name, GuildPermissions? permissions, Color? color, bool isHoisted, bool isMentionable, RequestOptions options)
Parameters
Type Name Description
System.String name
System.Nullable<GuildPermissions> permissions
System.Nullable<Color> color
System.Boolean isHoisted
System.Boolean isMentionable
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IRole>
| Improve this Doc View Source

IGuild.CreateTextChannelAsync(String, Action<TextChannelProperties>, RequestOptions)

Declaration
Task<ITextChannel> IGuild.CreateTextChannelAsync(string name, Action<TextChannelProperties> func, RequestOptions options)
Parameters
Type Name Description
System.String name
System.Action<TextChannelProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<ITextChannel>
| Improve this Doc View Source

IGuild.CreateVoiceChannelAsync(String, Action<VoiceChannelProperties>, RequestOptions)

Declaration
Task<IVoiceChannel> IGuild.CreateVoiceChannelAsync(string name, Action<VoiceChannelProperties> func, RequestOptions options)
Parameters
Type Name Description
System.String name
System.Action<VoiceChannelProperties> func
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IVoiceChannel>
| Improve this Doc View Source

IGuild.DefaultChannelId

Declaration
ulong IGuild.DefaultChannelId { get; }
Returns
Type Description
System.UInt64
| Improve this Doc View Source

IGuild.EmbedChannelId

Declaration
ulong? IGuild.EmbedChannelId { get; }
Returns
Type Description
System.Nullable<System.UInt64>
| Improve this Doc View Source

IGuild.EveryoneRole

Declaration
IRole IGuild.EveryoneRole { get; }
Returns
Type Description
IRole
| Improve this Doc View Source

IGuild.GetAFKChannelAsync(CacheMode, RequestOptions)

Declaration
Task<IVoiceChannel> IGuild.GetAFKChannelAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IVoiceChannel>
| Improve this Doc View Source

IGuild.GetAuditLogsAsync(Int32, CacheMode, RequestOptions, Nullable<UInt64>, Nullable<UInt64>, Nullable<ActionType>)

Declaration
Task<IReadOnlyCollection<IAuditLogEntry>> IGuild.GetAuditLogsAsync(int limit, CacheMode cacheMode, RequestOptions options, ulong? beforeId, ulong? userId, ActionType? actionType)
Parameters
Type Name Description
System.Int32 limit
CacheMode cacheMode
RequestOptions options
System.Nullable<System.UInt64> beforeId
System.Nullable<System.UInt64> userId
System.Nullable<ActionType> actionType
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IAuditLogEntry>>
| Improve this Doc View Source

IGuild.GetBanAsync(IUser, RequestOptions)

Declaration
Task<IBan> IGuild.GetBanAsync(IUser user, RequestOptions options)
Parameters
Type Name Description
IUser user
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IBan>
| Improve this Doc View Source

IGuild.GetBanAsync(UInt64, RequestOptions)

Declaration
Task<IBan> IGuild.GetBanAsync(ulong userId, RequestOptions options)
Parameters
Type Name Description
System.UInt64 userId
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IBan>
| Improve this Doc View Source

IGuild.GetBansAsync(RequestOptions)

Declaration
Task<IReadOnlyCollection<IBan>> IGuild.GetBansAsync(RequestOptions options)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IBan>>
| Improve this Doc View Source

IGuild.GetCategoriesAsync(CacheMode, RequestOptions)

Declaration
Task<IReadOnlyCollection<ICategoryChannel>> IGuild.GetCategoriesAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ICategoryChannel>>
| Improve this Doc View Source

IGuild.GetChannelAsync(UInt64, CacheMode, RequestOptions)

Declaration
Task<IGuildChannel> IGuild.GetChannelAsync(ulong id, CacheMode mode, RequestOptions options)
Parameters
Type Name Description
System.UInt64 id
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildChannel>
| Improve this Doc View Source

IGuild.GetChannelsAsync(CacheMode, RequestOptions)

Declaration
Task<IReadOnlyCollection<IGuildChannel>> IGuild.GetChannelsAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildChannel>>
| Improve this Doc View Source

IGuild.GetCurrentUserAsync(CacheMode, RequestOptions)

Declaration
Task<IGuildUser> IGuild.GetCurrentUserAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildUser>
| Improve this Doc View Source

IGuild.GetDefaultChannelAsync(CacheMode, RequestOptions)

Declaration
Task<ITextChannel> IGuild.GetDefaultChannelAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<ITextChannel>
| Improve this Doc View Source

IGuild.GetEmbedChannelAsync(CacheMode, RequestOptions)

Declaration
Task<IGuildChannel> IGuild.GetEmbedChannelAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildChannel>
| Improve this Doc View Source

IGuild.GetIntegrationsAsync(RequestOptions)

Declaration
Task<IReadOnlyCollection<IGuildIntegration>> IGuild.GetIntegrationsAsync(RequestOptions options)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildIntegration>>
| Improve this Doc View Source

IGuild.GetInvitesAsync(RequestOptions)

Declaration
Task<IReadOnlyCollection<IInviteMetadata>> IGuild.GetInvitesAsync(RequestOptions options)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>>
| Improve this Doc View Source

IGuild.GetOwnerAsync(CacheMode, RequestOptions)

Declaration
Task<IGuildUser> IGuild.GetOwnerAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildUser>
| Improve this Doc View Source

IGuild.GetRole(UInt64)

Declaration
IRole IGuild.GetRole(ulong id)
Parameters
Type Name Description
System.UInt64 id
Returns
Type Description
IRole
| Improve this Doc View Source

IGuild.GetSystemChannelAsync(CacheMode, RequestOptions)

Declaration
Task<ITextChannel> IGuild.GetSystemChannelAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<ITextChannel>
| Improve this Doc View Source

IGuild.GetTextChannelAsync(UInt64, CacheMode, RequestOptions)

Declaration
Task<ITextChannel> IGuild.GetTextChannelAsync(ulong id, CacheMode mode, RequestOptions options)
Parameters
Type Name Description
System.UInt64 id
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<ITextChannel>
| Improve this Doc View Source

IGuild.GetTextChannelsAsync(CacheMode, RequestOptions)

Declaration
Task<IReadOnlyCollection<ITextChannel>> IGuild.GetTextChannelsAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ITextChannel>>
| Improve this Doc View Source

IGuild.GetUserAsync(UInt64, CacheMode, RequestOptions)

Declaration
Task<IGuildUser> IGuild.GetUserAsync(ulong id, CacheMode mode, RequestOptions options)
Parameters
Type Name Description
System.UInt64 id
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IGuildUser>
| Improve this Doc View Source

IGuild.GetUsersAsync(CacheMode, RequestOptions)

Declaration
Task<IReadOnlyCollection<IGuildUser>> IGuild.GetUsersAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildUser>>
| Improve this Doc View Source

IGuild.GetVanityInviteAsync(RequestOptions)

Declaration
Task<IInviteMetadata> IGuild.GetVanityInviteAsync(RequestOptions options)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IInviteMetadata>
| Improve this Doc View Source

IGuild.GetVoiceChannelAsync(UInt64, CacheMode, RequestOptions)

Declaration
Task<IVoiceChannel> IGuild.GetVoiceChannelAsync(ulong id, CacheMode mode, RequestOptions options)
Parameters
Type Name Description
System.UInt64 id
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IVoiceChannel>
| Improve this Doc View Source

IGuild.GetVoiceChannelsAsync(CacheMode, RequestOptions)

Declaration
Task<IReadOnlyCollection<IVoiceChannel>> IGuild.GetVoiceChannelsAsync(CacheMode mode, RequestOptions options)
Parameters
Type Name Description
CacheMode mode
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceChannel>>
| Improve this Doc View Source

IGuild.GetVoiceRegionsAsync(RequestOptions)

Declaration
Task<IReadOnlyCollection<IVoiceRegion>> IGuild.GetVoiceRegionsAsync(RequestOptions options)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>>
| Improve this Doc View Source

IGuild.GetWebhookAsync(UInt64, RequestOptions)

Declaration
Task<IWebhook> IGuild.GetWebhookAsync(ulong id, RequestOptions options)
Parameters
Type Name Description
System.UInt64 id
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<IWebhook>
| Improve this Doc View Source

IGuild.GetWebhooksAsync(RequestOptions)

Declaration
Task<IReadOnlyCollection<IWebhook>> IGuild.GetWebhooksAsync(RequestOptions options)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>>
| Improve this Doc View Source

IGuild.Roles

Declaration
IReadOnlyCollection<IRole> IGuild.Roles { get; }
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<IRole>
| Improve this Doc View Source

IGuild.SystemChannelId

Declaration
ulong? IGuild.SystemChannelId { get; }
Returns
Type Description
System.Nullable<System.UInt64>
| Improve this Doc View Source

IDisposable.Dispose()

Declaration
void IDisposable.Dispose()

Implements

System.IDisposable