detritus
On this page

Partial Guild Structure

import { Structures } from 'detritus-client';

Structures.GuildPartial;
10 properties3 methods123 inheritedsrc/structures/guild.ts:600

Constructor

Properties

client
readonly
Inherited from BaseGuild.client
description
string | null
Default null
features
BaseSet<string>
Inherited from BaseGuild.features
icon
string | null
Default null
Inherited from BaseGuild.icon
id
string
Default ''
Inherited from BaseGuild.id
name
string
Default ''
Inherited from BaseGuild.name
nsfw
boolean
Default false
nsfwLevel
Default GuildNSFWLevels.DEFAULT
splash
string | null
Default null
vanityUrlCode
string | null
Default null
verificationLevel
number
Default 0
welcomeScreen
Default null

Accessors

acronym
string
get
Inherited from BaseGuild.acronym
bannerUrl
string | null
get
canHaveBanner
boolean
get
canHaveDiscoveryFeatures
boolean
get
canHaveNews
boolean
get
Inherited from BaseGuild.canHaveNews
canHavePublic
boolean
get
canHaveSplash
boolean
get
canHaveStore
boolean
get
Inherited from BaseGuild.canHaveStore
canHaveTextInVoice
boolean
get
canHaveVanityUrl
boolean
get
canHaveVipRegions
boolean
get
createdAt
Date
get
Inherited from BaseGuild.createdAt
createdAtUnix
number
get
iconUrl
string | null
get
Inherited from BaseGuild.iconUrl
isClone
boolean
get
Inherited from BaseGuild.isClone
isDiscoverable
boolean
get
isPartnered
boolean
get
Inherited from BaseGuild.isPartnered
isPublic
boolean
get
Inherited from BaseGuild.isPublic
isVerified
boolean
get
Inherited from BaseGuild.isVerified
shardId
number
get
Inherited from BaseGuild.shardId
splashUrl
string | null
get
widgetImageUrl
string
get
widgetUrl
string
get
Inherited from BaseGuild.widgetUrl

Methods

requestMembers()

async src/structures/guild.ts:524
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> }>
options
{ limit?: number; presences?: boolean; query: string; timeout?: number; userIds?: string[] }
options.limit?
number
options.presences?
boolean
options.query
string
options.timeout?
number
options.userIds?
string[]