Guild | 不和 (Fuwa)

Hierarchy

BaseStructure<APIGuild | APIUnavailableGuild>
- Guild

Index

Constructors

constructor

Accessors

Constructors

constructor

new Guild(client: Client): Guild

Overrides BaseStructure.constructor
- Defined in src/structures/Guild.ts:105
Parameters
- client: Client
Returns Guild

Properties

afkChannelId

afkChannelId: null | string = null

afkTimeout

afkTimeout: null | number = null

applicationId

applicationId: null | string = null

approximateMemberCount

approximateMemberCount: number = 0

approximatePresenceCount

approximatePresenceCount: number = 0

available

available: boolean = false

banner

banner: null | string = null

channels

channels: GuildChannelManager

client

client: Client

defaultMessageNotifications

defaultMessageNotifications: GuildDefaultMessageNotifications = GuildDefaultMessageNotifications.AllMessages

description

description: null | string = null

discoverySplash

discoverySplash: null | string = null

explicitContentFilter

explicitContentFilter: GuildExplicitContentFilter = GuildExplicitContentFilter.Disabled

features

features: GuildFeature[] = []

icon

icon: null | string = null

id

id: string

Optional joinedAt

joinedAt?: Date

large

large: boolean = false

Whether the guild is considered large by Discord.

maxMembers

maxMembers: number = Infinity

maxPresences

maxPresences: number = Infinity

maxVideoChannelUsers

maxVideoChannelUsers: number = Infinity

memberCount

memberCount: null | number = null

members

members: GuildMemberManager = ...

mfaLevel

mfaLevel: GuildMFALevel = GuildMFALevel.None

name

name: null | string = null

nsfwLevel

nsfwLevel: GuildNSFWLevel = GuildNSFWLevel.Default

ownerId

ownerId: string

preferredLocale

preferredLocale: string = 'en_US'

premiumProgressBarEnabled

premiumProgressBarEnabled: boolean = false

premiumSubscriptionCount

premiumSubscriptionCount: number = 0

premiumTier

premiumTier: GuildPremiumTier = GuildPremiumTier.None

presenceCount

presenceCount: null | number = null

publicUpdatesChannelId

publicUpdatesChannelId: null | string = null

rulesChannelId

rulesChannelId: null | string = null

splash

splash: null | string = null

systemChannelFlags

systemChannelFlags: null | GuildSystemChannelFlags = null

systemChannelId

systemChannelId: null | string = null

vanityURLCode

vanityURLCode: null | string = null

verificationLevel

verificationLevel: GuildVerificationLevel = GuildVerificationLevel.None

widgetChannelId

widgetChannelId: null | string = null

widgetEnabled

widgetEnabled: boolean = false

Accessors

createChannel

get createChannel(): { (options: CreateGuildChannelOptions): Promise<GuildChannels>; (name: string, type: GuildChannelType): Promise<GuildChannels> }

- Defined in src/structures/Guild.ts:408
Returns { (options: CreateGuildChannelOptions): Promise<GuildChannels>; (name: string, type: GuildChannelType): Promise<GuildChannels> }
- - (options: CreateGuildChannelOptions): Promise<GuildChannels>
  - (name: string, type: GuildChannelType): Promise<GuildChannels>
  - Parameters
    - options: CreateGuildChannelOptions
    Returns Promise<GuildChannels>
  - Parameters
    - name: string
    - type: GuildChannelType
    Returns Promise<GuildChannels>

createdAt

get createdAt(): Date

Inherited from BaseStructure.createdAt
- Defined in src/structures/templates/BaseStructure.ts:12
Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from BaseStructure.createdTimestamp
- Defined in src/structures/templates/BaseStructure.ts:9
Returns number

joinedTimestamp

get joinedTimestamp(): number

- Defined in src/structures/Guild.ts:73
Returns number

owner

get owner(): undefined | ExtendedUser | User

- Defined in src/structures/Guild.ts:36
Returns undefined | ExtendedUser | User

shard

get shard(): undefined | GatewayShard

- Defined in src/structures/Guild.ts:101
Returns undefined | GatewayShard

shardId

get shardId(): number

- Defined in src/structures/Guild.ts:97
Returns number

Methods

delete

delete(): Promise<void>

- Defined in src/structures/Guild.ts:348
Returns Promise<void>

edit

edit(data: Partial<Guild | APIGuild>, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:218
Parameters
- data: Partial<Guild | APIGuild>
- Optional reason: string
Returns Promise<Guild>

fetch

fetch(force?: boolean): Promise<Guild>

- Defined in src/structures/Guild.ts:214
Parameters
- force: boolean = true
Returns Promise<Guild>

leave

leave(): Promise<void>

- Defined in src/structures/Guild.ts:352
Returns Promise<void>

setAFKChannel

setAFKChannel(channel: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:283
Parameters
- channel: string
- Optional reason: string
Returns Promise<Guild>

setAFKTimeout

setAFKTimeout(timeout: number, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:279
Parameters
- timeout: number
- Optional reason: string
Returns Promise<Guild>

setBanner

setBanner(banner: null | FileResolvable, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:238
Parameters
- banner: null | FileResolvable
- Optional reason: string
Returns Promise<Guild>

setDefaultMessageNotifications

setDefaultMessageNotifications(notifications: GuildDefaultMessageNotifications, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:309
Parameters
- notifications: GuildDefaultMessageNotifications
- Optional reason: string
Returns Promise<Guild>

setDescription

setDescription(description: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:344
Parameters
- description: string
- Optional reason: string
Returns Promise<Guild>

setDiscoverySplash

setDiscoverySplash(splash: null | FileResolvable, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:256
Parameters
- splash: null | FileResolvable
- Optional reason: string
Returns Promise<Guild>

setExplicitContentFilter

setExplicitContentFilter(filter: GuildExplicitContentFilter, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:302
Parameters
- filter: GuildExplicitContentFilter
- Optional reason: string
Returns Promise<Guild>

setIcon

setIcon(icon: null | FileResolvable, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:231
Parameters
- icon: null | FileResolvable
- Optional reason: string
Returns Promise<Guild>

setMaxMembers

setMaxMembers(max: number, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:328
Parameters
- max: number
- Optional reason: string
Returns Promise<Guild>

setMaxPresences

setMaxPresences(max: number, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:332
Parameters
- max: number
- Optional reason: string
Returns Promise<Guild>

setMaxVideoChannelUsers

setMaxVideoChannelUsers(max: number, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:336
Parameters
- max: number
- Optional reason: string
Returns Promise<Guild>

setName

setName(name: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:268
Parameters
- name: string
- Optional reason: string
Returns Promise<Guild>

setPublicUpdatesChannel

setPublicUpdatesChannel(channel: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:324
Parameters
- channel: string
- Optional reason: string
Returns Promise<Guild>

setRegion

setRegion(region: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:275
deprecated
use {@link VoiceChannel.setRTCRegion} instead

Parameters
- region: string
- Optional reason: string
Returns Promise<Guild>

setSplash

setSplash(splash: null | FileResolvable, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:247
Parameters
- splash: null | FileResolvable
- Optional reason: string
Returns Promise<Guild>

setSystemChannel

setSystemChannel(channel: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:287
Parameters
- channel: string
- Optional reason: string
Returns Promise<Guild>

setSystemChannelFlags

setSystemChannelFlags(flags: GuildSystemChannelFlags, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:291
Parameters
- flags: GuildSystemChannelFlags
- Optional reason: string
Returns Promise<Guild>

setVanityURLCode

setVanityURLCode(code: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:340
Parameters
- code: string
- Optional reason: string
Returns Promise<Guild>

setVerificationLevel

setVerificationLevel(level: GuildVerificationLevel, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:298
Parameters
- level: GuildVerificationLevel
- Optional reason: string
Returns Promise<Guild>

setWidgetChannel

setWidgetChannel(channel: string, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:320
Parameters
- channel: string
- Optional reason: string
Returns Promise<Guild>

setWidgetEnabled

setWidgetEnabled(enabled: boolean, reason?: string): Promise<Guild>

- Defined in src/structures/Guild.ts:316
Parameters
- enabled: boolean
- Optional reason: string
Returns Promise<Guild>

toJSON

toJSON(): APIGuild

Overrides BaseStructure.toJSON
- Defined in src/structures/Guild.ts:356
Returns APIGuild

Static toJSON

toJSON(data: any): any

Inherited from BaseStructure.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns Guild

Properties

afkChannelId

afkTimeout

applicationId

approximateMemberCount

approximatePresenceCount

available

banner

channels

client

defaultMessageNotifications

description

discoverySplash

explicitContentFilter

features

icon

id

Optional joinedAt

large

maxMembers

maxPresences

maxVideoChannelUsers

memberCount

members

mfaLevel

name

nsfwLevel

ownerId

preferredLocale

premiumProgressBarEnabled

premiumSubscriptionCount

premiumTier

presenceCount

publicUpdatesChannelId

rulesChannelId

splash

systemChannelFlags

systemChannelId

vanityURLCode

verificationLevel

widgetChannelId

widgetEnabled

Accessors

createChannel

Returns { (options: CreateGuildChannelOptions): Promise<GuildChannels>; (name: string, type: GuildChannelType): Promise<GuildChannels> }

Parameters

options: CreateGuildChannelOptions

Returns Promise<GuildChannels>

Parameters

name: string

type: GuildChannelType

Returns Promise<GuildChannels>

createdAt

Returns Date

createdTimestamp

Returns number

joinedTimestamp

Returns number

owner

Returns undefined | ExtendedUser | User

shard

Returns undefined | GatewayShard

shardId

Returns number

Methods

delete

Returns Promise<void>

edit

Parameters