Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Guild

Guild Structure

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_fromRest

_fromRest: boolean = false

_keys

_keys: BaseSet<string> = keysGuild

_keysMerge

_keysMerge: BaseSet<string> = keysMergeGuild

_keysSkipDifference

_keysSkipDifference: BaseSet<string> = keysSkipDifferenceGuild

afkChannelId

afkChannelId: null | string = null

afkTimeout

afkTimeout: number = 0

Optional applicationId

applicationId: null | string

banner

banner: null | string = null

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 = GuildExplicitContentFilterTypes.DISABLED

features

features: BaseSet<string> = new 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 = DEFAULT_MAX_MEMBERS

maxPresences

maxPresences: number = DEFAULT_MAX_PRESENCES

maxVideoChannelUsers

maxVideoChannelUsers: number = DEFAULT_MAX_VIDEO_CHANNEL_USERS

memberCount

memberCount: number = 0

members

members: BaseCollection<string, Member>

mfaLevel

mfaLevel: MfaLevels = MfaLevels.NONE

name

name: string = ""

ownerId

ownerId: string = ""

preferredLocale

preferredLocale: Locales = Locales.ENGLISH_US

premiumSubscriptionCount

premiumSubscriptionCount: number = 0

premiumTier

premiumTier: PremiumGuildTiers = PremiumGuildTiers.NONE

publicUpdatesChannelId

publicUpdatesChannelId: null | string = null

region

region: string = ""

roles

roles: BaseCollection<string, Role>

rulesChannelId

rulesChannelId: null | string = null

splash

splash: null | string = null

systemChannelFlags

systemChannelFlags: number = 0

systemChannelId

systemChannelId: null | string = null

unavailable

unavailable: boolean = false

vanityUrlCode

vanityUrlCode: null | string = null

verificationLevel

verificationLevel: number = 0

widgetChannelId

widgetChannelId: null | string = null

widgetEnabled

widgetEnabled: boolean = false

Accessors

acronym

  • get acronym(): string
  • Returns string

afkChannel

  • Returns Channel | null

bannerUrl

  • get bannerUrl(): null | string
  • Returns 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

  • get channels(): BaseCollection<string, Channel>
  • Returns BaseCollection<string, Channel>

createdAt

  • get createdAt(): Date

createdAtUnix

  • get createdAtUnix(): number

defaultRole

  • get defaultRole(): null | Role
  • Returns null | Role

discoverySplashUrl

  • get discoverySplashUrl(): null | string
  • Returns null | string

hasSystemChannelSuppressJoinNotifications

  • get hasSystemChannelSuppressJoinNotifications(): boolean
  • Returns boolean

hasSystemChannelSuppressPremiumSubscriptions

  • get hasSystemChannelSuppressPremiumSubscriptions(): boolean
  • Returns boolean

iconUrl

  • get iconUrl(): null | string
  • Returns null | string

isDiscoverable

  • get isDiscoverable(): boolean

isPartnered

  • get isPartnered(): boolean

isPublic

  • get isPublic(): boolean
  • Returns boolean

isVerified

  • get isVerified(): boolean

joinedAt

  • get joinedAt(): Date | null
  • Returns Date | null

jumpLink

  • get jumpLink(): string
  • Returns string

maxAttachmentSize

  • get maxAttachmentSize(): number
  • Returns number

maxBitrate

  • get maxBitrate(): number
  • Returns number

maxEmojis

  • get maxEmojis(): number
  • Returns number

me

  • Returns Member | null

messages

  • get messages(): BaseCollection<string, Message>
  • Returns BaseCollection<string, Message>

owner

  • get owner(): null | User
  • Returns null | User

preferredLocaleText

  • get preferredLocaleText(): string
  • Returns string

presences

  • get presences(): BaseCollection<string, Presence>
  • Returns BaseCollection<string, Presence>

publicUpdatesChannel

  • get publicUpdatesChannel(): Channel | null
  • Returns Channel | null

rulesChannel

  • get rulesChannel(): Channel | null
  • Returns Channel | null

shardId

  • get shardId(): number
  • Returns number

splashUrl

  • get splashUrl(): null | string
  • Returns null | string

storeChannels

  • Returns BaseCollection<string, ChannelGuildStore>

systemChannel

  • get systemChannel(): Channel | null
  • Returns Channel | null

textChannels

  • Returns BaseCollection<string, ChannelGuildText>

voiceChannels

  • Returns BaseCollection<string, ChannelGuildVoice>

voiceStates

  • get voiceStates(): BaseCollection<string, VoiceState>
  • Returns BaseCollection<string, VoiceState>

widgetImageUrl

  • get widgetImageUrl(): string

widgetUrl

  • get widgetUrl(): string
  • Returns string

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

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

    • key: string
    • value: any

    Returns any

ack

  • ack(): Promise<any>
  • Returns Promise<any>

addMember

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

    • userId: string
    • options: AddGuildMember

    Returns Promise<any>

addMemberRole

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

    • userId: string
    • roleId: string

    Returns Promise<any>

bannerUrlFormat

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

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

beginPrune

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

    • Default value options: BeginGuildPrune = {}

    Returns Promise<any>

can

  • can(permissions: PermissionTools.PermissionChecks, member?: Member | null, options?: object): boolean
  • Parameters

    • permissions: PermissionTools.PermissionChecks
    • Optional member: Member | null
    • Default value options: object = {}
      • Optional ignoreAdministrator?: undefined | false | true
      • Optional ignoreOwner?: undefined | false | true

    Returns boolean

createBan

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

    • userId: string
    • options: CreateGuildBan

    Returns Promise<any>

createChannel

createEmoji

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

    • options: CreateGuildEmoji

    Returns Promise<Emoji>

createIntegration

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

    • options: CreateGuildIntegration

    Returns Promise<any>

createRole

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

    • options: CreateGuildRole

    Returns Promise<Role>

createTemplate

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

delete

  • delete(): Promise<any>
  • Returns Promise<any>

deleteChannel

deleteEmoji

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

    • emojiId: string
    • Default value options: DeleteGuildEmoji = {}

    Returns Promise<any>

deleteIntegration

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

    • integrationId: string
    • Default value options: DeleteGuildIntegration = {}

    Returns Promise<any>

deletePremiumSubscription

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

deleteRole

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

    • roleId: string
    • Default value options: DeleteGuildRole = {}

    Returns Promise<any>

deleteTemplate

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

    • templateId: string

    Returns Promise<any>

difference

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

    • key: string
    • value: any

    Returns [boolean, any]

differences

discoverySplashUrlFormat

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

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

edit

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

    • options: EditGuild

    Returns Promise<Guild>

editChannel

editChannelPositions

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

    • channels: EditGuildChannels
    • Default value options: EditGuildChannelsExtra = {}

    Returns Promise<any>

editEmbed

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

    • options: EditGuildEmbed

    Returns Promise<any>

editEmoji

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

    • emojiId: string
    • options: EditGuildEmoji

    Returns Promise<Emoji>

editIntegration

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

    • integrationId: string
    • options: EditGuildIntegration

    Returns Promise<any>

editMember

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

    • userId: string
    • options: EditGuildMember

    Returns Promise<any>

editMfaLevel

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

    • options: EditGuildMfaLevel

    Returns Promise<any>

editNick

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

    • nick: string
    • Default value options: EditGuildNick = {}

    Returns Promise<any>

editRole

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

    • roleId: string
    • options: EditGuildRole

    Returns Promise<Role>

editRolePositions

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

    • roles: EditGuildRolePositions
    • Default value options: EditGuildRolePositionsExtra = {}

    Returns Promise<BaseCollection<string, Role>>

editVanityUrl

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

    • code: string
    • Default value options: EditGuildVanity = {}

    Returns Promise<any>

fetchApplications

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

    • Optional channelId: undefined | string

    Returns Promise<any>

fetchAuditLogs

  • fetchAuditLogs(options: FetchGuildAuditLogs): Promise<BaseCollection<string, AuditLog>>
  • Parameters

    • options: FetchGuildAuditLogs

    Returns Promise<BaseCollection<string, AuditLog>>

fetchBans

fetchChannels

fetchEmbed

  • fetchEmbed(): Promise<any>
  • Returns Promise<any>

fetchEmoji

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

    • emojiId: string

    Returns Promise<Emoji>

fetchEmojis

  • fetchEmojis(): Promise<BaseCollection<string, Emoji>>

fetchIntegrations

  • fetchIntegrations(): Promise<BaseCollection<string, Integration>>

fetchInvites

  • fetchInvites(): Promise<BaseCollection<string, Invite>>

fetchMember

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

fetchMembers

  • fetchMembers(options: FetchGuildMembers): Promise<BaseCollection<string, Member>>
  • Parameters

    • options: FetchGuildMembers

    Returns Promise<BaseCollection<string, Member>>

fetchMembersSearch

  • fetchMembersSearch(options: FetchGuildMembersSearch): Promise<BaseCollection<string, Member>>
  • Parameters

    • options: FetchGuildMembersSearch

    Returns Promise<BaseCollection<string, Member>>

fetchPremiumSubscriptions

fetchPruneCount

  • fetchPruneCount(): Promise<any>

fetchRoles

  • fetchRoles(): Promise<BaseCollection<string, Role>>
  • Returns Promise<BaseCollection<string, Role>>

fetchTemplates

  • fetchTemplates(): Promise<BaseCollection<string, Template>>

fetchVanityUrl

  • fetchVanityUrl(): Promise<any>

fetchVoiceRegion

  • Returns Promise<VoiceRegion>

fetchVoiceRegions

  • fetchVoiceRegions(): Promise<BaseCollection<string, VoiceRegion>>

fetchWebhooks

  • fetchWebhooks(): Promise<BaseCollection<string, Webhook>>

fetchWidget

  • fetchWidget(): Promise<any>

fetchWidgetJson

  • fetchWidgetJson(): Promise<any>

fetchWidgetPng

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

    • Default value options: FetchGuildWidgetPng = {}

    Returns Promise<any>

hasFeature

  • hasFeature(feature: string): boolean
  • Parameters

    • feature: string

    Returns boolean

hasSystemChannelFlag

  • hasSystemChannelFlag(flag: number): boolean
  • Parameters

    • flag: number

    Returns boolean

iconUrlFormat

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

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

isOwner

  • isOwner(userId: string): boolean
  • Parameters

    • userId: string

    Returns boolean

join

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

    • options: JoinGuild

    Returns Promise<any>

leave

  • leave(): Promise<any>
  • Returns Promise<any>

merge

mergeValue

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

    • key: string
    • value: any

    Returns void

removeBan

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

    • userId: string
    • Default value options: RemoveGuildBan = {}

    Returns Promise<any>

removeMember

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

    • userId: string
    • Default value options: RemoveGuildMember = {}

    Returns Promise<any>

removeMemberRole

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

    • userId: string
    • roleId: string
    • Default value options: RemoveGuildBan = {}

    Returns Promise<any>

requestMembers

  • requestMembers(options: object): Promise<object>
  • Parameters

    • options: object
      • Optional limit?: undefined | number
      • Optional presences?: undefined | false | true
      • query: string
      • Optional timeout?: undefined | number
      • Optional userIds?: Array<string>

    Returns Promise<object>

search

  • search(options: SearchOptions, retry?: undefined | false | true): Promise<any>
  • Parameters

    • options: SearchOptions
    • Optional retry: undefined | false | true

    Returns Promise<any>

splashUrlFormat

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

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

syncIntegration

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

    • integrationId: string

    Returns Promise<any>

toJSON

  • toJSON(): object
  • Returns object

toString

  • toString(): string
  • Returns string

widgetImageUrlFormat

  • widgetImageUrlFormat(query?: UrlQuery): string

widgetUrlFormat

  • widgetUrlFormat(options?: RouteWidget): string
  • Parameters

    • Default value options: RouteWidget = {}

    Returns string

Generated using TypeDoc