Options
All
  • Public
  • Public/Protected
  • All
Menu

Guild Structure

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly _channelIds

_channelIds: BaseSet<string> = ...

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

Readonly _keysSkipDifference

_keysSkipDifference: BaseSet<string> = ...

Readonly _threadIds

_threadIds: BaseSet<string> = ...

afkChannelId

afkChannelId: null | string = null

afkTimeout

afkTimeout: number = 0

applicationCommandCount

applicationCommandCount: number = 0

Optional applicationId

applicationId: null | string

banner

banner: null | string = null

Readonly client

client: ShardClient

defaultMessageNotifications

defaultMessageNotifications: number = 0

description

description: null | string = null

discoverySplash

discoverySplash: null | string = null

embedChannelId

embedChannelId: null | string = null

embedEnabled

embedEnabled: boolean = false

emojis

emojis: BaseCollection<string, Emoji>

explicitContentFilter

explicitContentFilter: GuildExplicitContentFilterTypes = ...

features

features: BaseSet<string> = ...

hasMetadata

hasMetadata: boolean = false

icon

icon: null | string = null

id

id: string = ''

isPartial

isPartial: boolean = false

isReady

isReady: boolean = false

joinedAtUnix

joinedAtUnix: number = 0

large

large: boolean = false

lazy

lazy: boolean = false

left

left: boolean = false

maxMembers

maxMembers: number = ...

maxPresences

maxPresences: number = ...

maxVideoChannelUsers

maxVideoChannelUsers: number = ...

memberCount

memberCount: number = 0

members

members: BaseCollection<string, Member>

mfaLevel

mfaLevel: MfaLevels = ...

name

name: string = ''

nsfw

nsfw: boolean = false

nsfwLevel

nsfwLevel: GuildNSFWLevels = ...

ownerId

ownerId: string = ''

preferredLocale

preferredLocale: Locales = ...

premiumSubscriptionCount

premiumSubscriptionCount: number = 0

premiumTier

premiumTier: PremiumGuildTiers = ...

publicUpdatesChannelId

publicUpdatesChannelId: null | string = null

region

region: string = ''

roles

roles: BaseCollection<string, Role>

rulesChannelId

rulesChannelId: null | string = null

splash

splash: null | string = null

stageInstances

stageInstances: BaseCollection<string, StageInstance>

stickers

stickers: BaseCollection<string, Sticker>

systemChannelFlags

systemChannelFlags: number = 0

systemChannelId

systemChannelId: null | string = null

unavailable

unavailable: boolean = false

vanityUrlCode

vanityUrlCode: null | string = null

verificationLevel

verificationLevel: number = 0

welcomeScreen

welcomeScreen: null | GuildWelcomeScreen = null

widgetChannelId

widgetChannelId: null | string = null

widgetEnabled

widgetEnabled: boolean = false

Accessors

acronym

  • get acronym(): string

afkChannel

allTextChannels

allVoiceChannels

bannerUrl

  • get bannerUrl(): null | string

canHaveBanner

  • get canHaveBanner(): boolean

canHaveDiscoveryFeatures

  • get canHaveDiscoveryFeatures(): boolean

canHaveNews

  • get canHaveNews(): boolean

canHavePublic

  • get canHavePublic(): boolean

canHaveSplash

  • get canHaveSplash(): boolean

canHaveStore

  • get canHaveStore(): boolean

canHaveVanityUrl

  • get canHaveVanityUrl(): boolean

canHaveVipRegions

  • get canHaveVipRegions(): boolean

categoryChannels

channels

createdAt

  • get createdAt(): Date

createdAtUnix

  • get createdAtUnix(): number

defaultRole

  • get defaultRole(): null | Role

discoverySplashUrl

  • get discoverySplashUrl(): null | string

hasSystemChannelSuppressJoinNotifications

  • get hasSystemChannelSuppressJoinNotifications(): boolean

hasSystemChannelSuppressPremiumSubscriptions

  • get hasSystemChannelSuppressPremiumSubscriptions(): boolean

iconUrl

  • get iconUrl(): null | string

isClone

  • get isClone(): boolean

isDiscoverable

  • get isDiscoverable(): boolean

isPartnered

  • get isPartnered(): boolean

isPublic

  • get isPublic(): boolean

isVerified

  • get isVerified(): boolean

joinedAt

  • get joinedAt(): null | Date

jumpLink

  • get jumpLink(): string

maxAttachmentSize

  • get maxAttachmentSize(): number

maxBitrate

  • get maxBitrate(): number

maxEmojis

  • get maxEmojis(): number

me

messages

owner

  • get owner(): null | User

preferredLocaleText

  • get preferredLocaleText(): string

presences

publicUpdatesChannel

  • get publicUpdatesChannel(): null | Channel

rulesChannel

  • get rulesChannel(): null | Channel

shardId

  • get shardId(): number

splashUrl

  • get splashUrl(): null | string

stageVoiceChannels

storeChannels

systemChannel

  • get systemChannel(): null | Channel

textChannels

threads

voiceChannels

voiceStates

widgetImageUrl

  • get widgetImageUrl(): string

widgetUrl

  • get widgetUrl(): string

Methods

[custom]

  • [custom](): object

_getFromSnake

  • _getFromSnake(key: string): any

_setFromSnake

  • _setFromSnake(key: string, value: any): any

ack

  • ack(): Promise<any>

addMember

  • addMember(userId: string, options: AddGuildMember): Promise<any>

addMemberRole

  • addMemberRole(userId: string, roleId: string): Promise<any>

bannerUrlFormat

  • bannerUrlFormat(format?: null | string, query?: UrlQuery): null | string

beginPrune

  • beginPrune(options?: BeginGuildPrune): Promise<any>

can

  • can(permissions: PermissionChecks, member?: null | Member, options?: { ignoreAdministrator?: boolean; ignoreOwner?: boolean }): boolean
  • Parameters

    • permissions: PermissionChecks
    • Optional member: null | Member
    • options: { ignoreAdministrator?: boolean; ignoreOwner?: boolean } = {}
      • Optional ignoreAdministrator?: boolean
      • Optional ignoreOwner?: boolean

    Returns boolean

clone

createBan

  • createBan(userId: string, options: CreateGuildBan): Promise<any>

createChannel

  • createChannel(options: CreateGuildChannel): Promise<Channel>

createEmoji

  • createEmoji(options: CreateGuildEmoji): Promise<Emoji>

createIntegration

  • createIntegration(options: CreateGuildIntegration): Promise<any>

createRole

  • createRole(options: CreateGuildRole): Promise<Role>

createSticker

  • createSticker(options: CreateGuildSticker): Promise<Sticker>

createTemplate

  • createTemplate(options: CreateGuildTemplate): Promise<Template>

delete

  • delete(): Promise<any>

deleteChannel

  • deleteChannel(channelId: string, options?: DeleteChannel): Promise<Channel>

deleteEmoji

  • deleteEmoji(emojiId: string, options?: DeleteGuildEmoji): Promise<any>

deleteIntegration

  • deleteIntegration(integrationId: string, options?: DeleteGuildIntegration): Promise<any>

deletePremiumSubscription

  • deletePremiumSubscription(subscriptionId: string): Promise<any>

deleteRole

  • deleteRole(roleId: string, options?: DeleteGuildRole): Promise<any>

deleteSticker

  • deleteSticker(stickerId: string): Promise<any>

deleteTemplate

  • deleteTemplate(templateId: string): Promise<any>

difference

  • difference(key: string, value: any): [boolean, any]

differences

differencesBetween

  • differencesBetween(structure: Structure): null | object

discoverySplashUrlFormat

  • discoverySplashUrlFormat(format?: null | string, query?: UrlQuery): null | string

edit

  • edit(options: EditGuild): Promise<Guild>

editChannel

  • editChannel(channelId: string, options: EditChannel): Promise<Channel>

editChannelPositions

  • editChannelPositions(channels: EditGuildChannels, options?: EditGuildChannelsExtra): Promise<any>

editEmbed

  • editEmbed(options: EditGuildEmbed): Promise<any>

editEmoji

  • editEmoji(emojiId: string, options: EditGuildEmoji): Promise<Emoji>

editIntegration

  • editIntegration(integrationId: string, options: EditGuildIntegration): Promise<any>

editMember

  • editMember(userId: string, options: EditGuildMember): Promise<any>

editMfaLevel

  • editMfaLevel(options: EditGuildMfaLevel): Promise<any>

editNick

  • editNick(nick: string, options?: EditGuildNick): Promise<any>

editRole

  • editRole(roleId: string, options: EditGuildRole): Promise<Role>

editRolePositions

  • editRolePositions(roles: EditGuildRolePositions, options?: EditGuildRolePositionsExtra): Promise<BaseCollection<string, Role>>

editSticker

  • editSticker(stickerId: string, options?: EditGuildSticker): Promise<Sticker>

editVanityUrl

  • editVanityUrl(code: string, options?: EditGuildVanity): Promise<any>

editVoiceState

  • editVoiceState(userId: string, options: EditGuildVoiceState): Promise<any>

fetchApplications

  • fetchApplications(channelId?: string): Promise<any>

fetchAuditLogs

fetchBans

fetchChannels

fetchEmbed

  • fetchEmbed(): Promise<any>

fetchEmoji

  • fetchEmoji(emojiId: string): Promise<Emoji>

fetchEmojis

fetchIntegrations

fetchInvites

fetchMember

  • fetchMember(userId: string): Promise<Member>

fetchMembers

fetchMembersSearch

fetchPremiumSubscriptions

fetchPruneCount

  • fetchPruneCount(): Promise<any>

fetchRoles

fetchSticker

  • fetchSticker(stickerId: string): Promise<Sticker>

fetchStickers

fetchTemplates

fetchVanityUrl

  • fetchVanityUrl(): Promise<any>

fetchVoiceRegion

fetchVoiceRegions

fetchWebhooks

fetchWidget

  • fetchWidget(): Promise<any>

fetchWidgetJson

  • fetchWidgetJson(): Promise<any>

fetchWidgetPng

  • fetchWidgetPng(options?: FetchGuildWidgetPng): Promise<any>

hasDifference

  • hasDifference(key: string, value: any): boolean

hasDifferences

hasDifferencesBetween

  • hasDifferencesBetween(structure: Structure): boolean

hasFeature

  • hasFeature(feature: string): boolean

hasSystemChannelFlag

  • hasSystemChannelFlag(flag: number): boolean

iconUrlFormat

  • iconUrlFormat(format?: null | string, query?: UrlQuery): null | string

isOwner

  • isOwner(userId: string): boolean

join

  • join(options: JoinGuild): Promise<any>

leave

  • leave(): Promise<any>

merge

mergeValue

  • mergeValue(key: string, value: any): void

removeBan

  • removeBan(userId: string, options?: RemoveGuildBan): Promise<any>

removeMember

  • removeMember(userId: string, options?: RemoveGuildMember): Promise<any>

removeMemberRole

  • removeMemberRole(userId: string, roleId: string, options?: RemoveGuildBan): Promise<any>

requestMembers

  • requestMembers(options: { limit?: number; presences?: boolean; query: string; timeout?: number; userIds?: string[] }): Promise<{ members: BaseCollection<string, Member>; nonce: string; notFound: BaseSet<string>; presences: BaseCollection<string, Presence> }>

search

  • search(options: SearchOptions, retry?: boolean): Promise<any>

splashUrlFormat

  • splashUrlFormat(format?: null | string, query?: UrlQuery): null | string

syncIntegration

  • syncIntegration(integrationId: string): Promise<any>

toJSON

  • toJSON(): object

toString

  • toString(): string

widgetImageUrlFormat

  • widgetImageUrlFormat(query?: UrlQuery): string

widgetUrlFormat

  • widgetUrlFormat(options?: RouteWidget): string

Generated using TypeDoc