Class DiscordGuild

A local representation for DiscordGuildData.

Inheritance

System.Object

DiscordGuild

Implements

IDiscordGuild

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Color_Chan.Discord.Rest.Models.Guild

Assembly: Color-Chan.Discord.Rest.dll

Syntax

public class DiscordGuild : IDiscordGuild

Constructors

| Improve this Doc View Source

DiscordGuild(DiscordGuildData)

Initializes a new DiscordGuild

Declaration

public DiscordGuild(DiscordGuildData data)

Parameters

Type	Name	Description
DiscordGuildData	data	The data needed to create the DiscordGuild.

Properties

| Improve this Doc View Source

AfkChannelId

Id of afk channel.

Declaration

public ulong? AfkChannelId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

| Improve this Doc View Source

AfkTimeout

Afk timeout in seconds.

Declaration

public int AfkTimeout { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

ApplicationId

Application id of the guild creator if it is bot-created.

Declaration

public ulong? ApplicationId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

| Improve this Doc View Source

ApproximateMemberCount

Approximate number of members in this guild, returned from the GET /guilds/{id} endpoint when with_counts is true.

Declaration

public int? ApproximateMemberCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

ApproximatePresenceCount

Approximate number of non-offline members in this guild, returned from the GET /guilds/{id} endpoint when with_counts is true.

Declaration

public int? ApproximatePresenceCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

Banner

Banner hash.

Declaration

public string Banner { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Channels

Channels in the guild.

Declaration

public IEnumerable<IDiscordChannel> Channels { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IDiscordChannel>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

CurrentUserPermission

Total permissions for the user in the guild (excludes overwrites).

Declaration

public string CurrentUserPermission { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DefaultMessageNotifications

Default message notifications level.

Declaration

public DiscordGuildDefaultMessageNotificationLevel DefaultMessageNotifications { get; set; }

Property Value

Type	Description
DiscordGuildDefaultMessageNotificationLevel

| Improve this Doc View Source

Description

The description of a Community guild.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DiscoverySplash

Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature.

Declaration

public string DiscoverySplash { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Emojis

Custom guild emojis.

Declaration

public IEnumerable<IDiscordEmoji> Emojis { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IDiscordEmoji>

| Improve this Doc View Source

ExplicitContentFilter

Explicit content filter level.

Declaration

public DiscordGuildExplicitContentFilterLevel ExplicitContentFilter { get; set; }

Property Value

Type	Description
DiscordGuildExplicitContentFilterLevel

| Improve this Doc View Source

Features

Enabled guild features.

Declaration

public IEnumerable<DiscordGuildFeature> Features { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<DiscordGuildFeature>

| Improve this Doc View Source

Icon

Icon hash.

Declaration

public string Icon { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IconHash

Icon hash, returned when in the template object.

Declaration

public string IconHash { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Id

The Discord provided snowflake id.

Declaration

public ulong Id { get; set; }

Property Value

Type	Description
System.UInt64

| Improve this Doc View Source

IsOwner

True if the user is the owner of the guild.

Declaration

public bool? IsOwner { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Only sent when using the GET Current User Guilds endpoint and are relative to the requested user.

| Improve this Doc View Source

JoinedAt

When the current user joined this guild.

Declaration

public DateTimeOffset? JoinedAt { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

Large

True if this is considered a large guild.

Declaration

public bool? Large { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

MaxMembers

The maximum number of members for the guild.

Declaration

public int? MaxMembers { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

MaxPresences

The maximum number of presences for the guild (null is always returned, apart from the largest of guilds).

Declaration

public int? MaxPresences { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

MaxVideoChannelUsers

The maximum amount of users in a video channel.

Declaration

public int? MaxVideoChannelUsers { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

MemberCount

Total number of members in this guild.

Declaration

public int? MemberCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

Members

Users in the guild.

Declaration

public IEnumerable<IDiscordGuildMember> Members { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IDiscordGuildMember>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

MfaLevel

Required MFA level for the guild.

Declaration

public DiscordGuildMfaLevel MfaLevel { get; set; }

Property Value

Type	Description
DiscordGuildMfaLevel

| Improve this Doc View Source

Name

Guild name (2-100 characters, excluding trailing and leading whitespace).

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

NsfwLevel

Guild NSFW level.

Declaration

public DiscordGuildNsfwLevel NsfwLevel { get; set; }

Property Value

Type	Description
DiscordGuildNsfwLevel

| Improve this Doc View Source

OwnerId

Id of owner.

Declaration

public ulong OwnerId { get; set; }

Property Value

Type	Description
System.UInt64

| Improve this Doc View Source

PreferredLocale

The preferred locale of a Community guild; used in server discovery and notices from Discord; defaults to "en-US".

Declaration

public string PreferredLocale { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PremiumSubscriptionCount

The number of boosts this guild currently has.

Declaration

public int? PremiumSubscriptionCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

PremiumTier

Premium tier (Server Boost level).

Declaration

public DiscordGuildPremiumTier PremiumTier { get; set; }

Property Value

Type	Description
DiscordGuildPremiumTier

| Improve this Doc View Source

Presences

presences of the members in the guild, will only include non-offline members if the size is greater than large threshold.

Declaration

public IEnumerable<DiscordGuildPresenceData> Presences { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<DiscordGuildPresenceData>

Remarks

Only send on the 'GUILD_CREATE' event.

If you are using Gateway Intents, you must specify the GUILD_PRESENCES intent in order to receive Presence Update events.

| Improve this Doc View Source

PublicUpdatesChannelId

The id of the channel where admins and moderators of Community guilds receive notices from Discord.

Declaration

public ulong? PublicUpdatesChannelId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

| Improve this Doc View Source

Region

Voice region id for the guild (deprecated).

Declaration

public string Region { get; set; }

Property Value

Type	Description
System.String

Remarks

This field is deprecated and will be removed in v9 and is replaced by rtc_region.

| Improve this Doc View Source

Roles

Roles in the guild.

Declaration

public IEnumerable<IDiscordGuildRole> Roles { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IDiscordGuildRole>

| Improve this Doc View Source

RulesChannelId

The id of the channel where Community guilds can display rules and/or guidelines.

Declaration

public ulong? RulesChannelId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

| Improve this Doc View Source

Splash

Splash hash.

Declaration

public string Splash { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

StageInstances

Stage instances in the guild.

Declaration

public IDiscordStageInstance StageInstances { get; set; }

Property Value

Type	Description
IDiscordStageInstance

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

SystemChannelFlags

The system channel flags.

Declaration

public DiscordSystemChannelFlags SystemChannelFlags { get; set; }

Property Value

Type	Description
DiscordSystemChannelFlags

| Improve this Doc View Source

SystemChannelId

The id of the channel where guild notices such as welcome messages and boost events are posted.

Declaration

public ulong? SystemChannelId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

| Improve this Doc View Source

Threads

All active threads in the guild that current user has permission to view.

Declaration

public IEnumerable<IDiscordChannel> Threads { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IDiscordChannel>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

Unavailable

True if this guild is unavailable due to an outage.

Declaration

public bool? Unavailable { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

VanityUrlCode

The vanity url code for the guild.

Declaration

public string VanityUrlCode { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

VerificationLevel

Verification level required for the guild.

Declaration

public DiscordGuildVerificationLevel VerificationLevel { get; set; }

Property Value

Type	Description
DiscordGuildVerificationLevel

| Improve this Doc View Source

VoiceStates

States of members currently in voice channels; lacks the guild_id key.

Declaration

public IEnumerable<DiscordVoiceState> VoiceStates { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<DiscordVoiceState>

Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

WelcomeScreen

The welcome screen of a Community guild, shown to new members, returned in an Invite's guild object.

Declaration

public IDiscordGuildWelcomeScreen WelcomeScreen { get; set; }

Property Value

Type	Description
IDiscordGuildWelcomeScreen

| Improve this Doc View Source

WidgetChannelId

The channel id that the widget will generate an invite to, or null if set to no invite.

Declaration

public ulong? WidgetChannelId { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt64>

| Improve this Doc View Source

WidgetEnabled

True if the server widget is enabled.

Declaration

public bool? WidgetEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Implements

IDiscordGuild