Class DiscordGuildData

Represents a discord Guild Structure API model. Docs: https://discord.com/developers/docs/resources/guild#guild-object-guild-structure

Inheritance
Object
DiscordGuildData
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Color_Chan.Discord.Core.Common.API.DataModels.Guild
Assembly: Color-Chan.Discord.Core.dll
Syntax
public class DiscordGuildData : IEquatable<DiscordGuildData>

Properties

| Improve this Doc View Source

AfkChannelId

Id of afk channel.

Declaration
[JsonPropertyName("afk_channel_id")]
public ulong? AfkChannelId { get; set; }
Property Value
Type Description
System.Nullable<System.UInt64>
| Improve this Doc View Source

AfkTimeout

Afk timeout in seconds.

Declaration
[JsonPropertyName("afk_timeout")]
public int AfkTimeout { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

ApplicationId

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

Declaration
[JsonPropertyName("application_id")]
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
[JsonPropertyName("approximate_member_count")]
public int? ApproximateMemberCount { get; set; }
Property Value
Type Description
System.Nullable<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
[JsonPropertyName("approximate_presence_count")]
public int? ApproximatePresenceCount { get; set; }
Property Value
Type Description
System.Nullable<Int32>
| Improve this Doc View Source

Banner

Banner hash.

Declaration
[JsonPropertyName("banner")]
public string Banner { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Channels

Channels in the guild.

Declaration
[JsonPropertyName("channels")]
public IEnumerable<DiscordChannelData> Channels { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DiscordChannelData>
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
[JsonPropertyName("permission")]
public string CurrentUserPermission { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

DefaultMessageNotifications

Default message notifications level.

Declaration
[JsonPropertyName("default_message_notifications")]
public DiscordGuildDefaultMessageNotificationLevel DefaultMessageNotifications { get; set; }
Property Value
Type Description
DiscordGuildDefaultMessageNotificationLevel
| Improve this Doc View Source

Description

The description of a Community guild.

Declaration
[JsonPropertyName("description")]
public string Description { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

DiscoverySplash

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

Declaration
[JsonPropertyName("discovery_splash")]
public string DiscoverySplash { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Emojis

Custom guild emojis.

Declaration
[JsonPropertyName("emojis")]
public IEnumerable<DiscordEmojiData> Emojis { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DiscordEmojiData>
| Improve this Doc View Source

ExplicitContentFilter

Explicit content filter level.

Declaration
[JsonPropertyName("explicit_content_filter")]
public DiscordGuildExplicitContentFilterLevel ExplicitContentFilter { get; set; }
Property Value
Type Description
DiscordGuildExplicitContentFilterLevel
| Improve this Doc View Source

Features

Enabled guild features.

Declaration
[JsonPropertyName("features")]
public IEnumerable<DiscordGuildFeature> Features { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DiscordGuildFeature>
| Improve this Doc View Source

Icon

Icon hash.

Declaration
[JsonPropertyName("icon")]
public string Icon { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

IconHash

Icon hash, returned when in the template object.

Declaration
[JsonPropertyName("icon_hash")]
public string IconHash { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Id

Guild id.

Declaration
[JsonPropertyName("id")]
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
[JsonPropertyName("owner")]
public bool? IsOwner { get; set; }
Property Value
Type Description
System.Nullable<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
[JsonPropertyName("joined_at")]
public DateTimeOffset? JoinedAt { get; set; }
Property Value
Type Description
System.Nullable<DateTimeOffset>
Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

Large

True if this is considered a large guild.

Declaration
[JsonPropertyName("large")]
public bool? Large { get; set; }
Property Value
Type Description
System.Nullable<Boolean>
Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

MaxMembers

The maximum number of members for the guild.

Declaration
[JsonPropertyName("max_members")]
public int? MaxMembers { get; set; }
Property Value
Type Description
System.Nullable<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
[JsonPropertyName("max_presences")]
public int? MaxPresences { get; set; }
Property Value
Type Description
System.Nullable<Int32>
| Improve this Doc View Source

MaxVideoChannelUsers

The maximum amount of users in a video channel.

Declaration
[JsonPropertyName("max_video_channel_users")]
public int? MaxVideoChannelUsers { get; set; }
Property Value
Type Description
System.Nullable<Int32>
| Improve this Doc View Source

MemberCount

Total number of members in this guild.

Declaration
[JsonPropertyName("member_count")]
public int? MemberCount { get; set; }
Property Value
Type Description
System.Nullable<Int32>
Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

Members

Users in the guild.

Declaration
[JsonPropertyName("members")]
public IEnumerable<DiscordGuildMemberData> Members { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DiscordGuildMemberData>
Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

MfaLevel

Required MFA level for the guild.

Declaration
[JsonPropertyName("mfa_level")]
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
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

NsfwLevel

Guild NSFW level.

Declaration
[JsonPropertyName("nsfw_level")]
public DiscordGuildNsfwLevel NsfwLevel { get; set; }
Property Value
Type Description
DiscordGuildNsfwLevel
| Improve this Doc View Source

OwnerId

Id of owner.

Declaration
[JsonPropertyName("owner_id")]
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
[JsonPropertyName("preferred_locale")]
public string PreferredLocale { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

PremiumSubscriptionCount

The number of boosts this guild currently has.

Declaration
[JsonPropertyName("premium_subscription_count")]
public int? PremiumSubscriptionCount { get; set; }
Property Value
Type Description
System.Nullable<Int32>
| Improve this Doc View Source

PremiumTier

Premium tier (Server Boost level).

Declaration
[JsonPropertyName("premium_tier")]
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
[JsonPropertyName("presences")]
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
[JsonPropertyName("public_updates_channel_id")]
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
[Obsolete("This field is deprecated and will be removed in v9 and is replaced by rtc_region")]
[JsonPropertyName("region")]
public string Region { get; set; }
Property Value
Type Description
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
[JsonPropertyName("roles")]
public IEnumerable<DiscordGuildRoleData> Roles { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DiscordGuildRoleData>
| Improve this Doc View Source

RulesChannelId

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

Declaration
[JsonPropertyName("rules_channel_id")]
public ulong? RulesChannelId { get; set; }
Property Value
Type Description
System.Nullable<System.UInt64>
| Improve this Doc View Source

Splash

Splash hash.

Declaration
[JsonPropertyName("splash")]
public string Splash { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

StageInstances

Stage instances in the guild.

Declaration
[JsonPropertyName("stage_instances")]
public DiscordStageinstanceData StageInstances { get; set; }
Property Value
Type Description
DiscordStageinstanceData
Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

SystemChannelFlags

The system channel flags.

Declaration
[JsonPropertyName("system_channel_flags")]
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
[JsonPropertyName("system_channel_id")]
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
[JsonPropertyName("threads")]
public IEnumerable<DiscordChannelData> Threads { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<DiscordChannelData>
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
[JsonPropertyName("unavailable")]
public bool? Unavailable { get; set; }
Property Value
Type Description
System.Nullable<Boolean>
Remarks

Only send on the 'GUILD_CREATE' event.

| Improve this Doc View Source

VanityUrlCode

The vanity url code for the guild.

Declaration
[JsonPropertyName("vanity_url_code")]
public string VanityUrlCode { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

VerificationLevel

Verification level required for the guild.

Declaration
[JsonPropertyName("verification_level")]
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
[JsonPropertyName("voice_states")]
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
[JsonPropertyName("welcome_screen")]
public DiscordGuildWelcomeScreenData WelcomeScreen { get; set; }
Property Value
Type Description
DiscordGuildWelcomeScreenData
| 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
[JsonPropertyName("widget_channel_id")]
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
[JsonPropertyName("widget_enabled")]
public bool? WidgetEnabled { get; set; }
Property Value
Type Description
System.Nullable<Boolean>

Implements