Class GuildPreview

Represent Discord Guild Preview Object

Link

https://discord.com/developers/docs/resources/guild#guild-preview-object

Hierarchy (View Summary)

AnonymousGuild
- GuildPreview

Index

Constructors

constructor

new GuildPreview(client: UsingClient, data: APIGuildPreview): GuildPreview
Parameters
- client: UsingClient
- data: APIGuildPreview
Returns GuildPreview
Overrides AnonymousGuild.constructor
- Defined in src/structures/GuildPreview.ts:10

Properties

`Optional`banner

banner?: string | null

`Readonly`client

client: UsingClient

`Optional`description

description?: string | null

`Optional`features

features?: GuildFeature[]

icon

icon: string | null

id

id: string

name

name: string

splash

splash: string | null

`Optional`vanityUrlCode

vanityUrlCode?: string | null

`Optional`verificationLevel

verificationLevel?: GuildVerificationLevel

`Optional`welcomeScreen

welcomeScreen?: {
    description: string | null;
    welcomeChannels: {
        channelId: string;
        description: string;
        emojiId: string | null;
        emojiName: string | null;
    }[];
}

Accessors

createdAt

get createdAt(): Date
createdAt gets the creation Date instace of the current object.

Returns Date
Inherited from AnonymousGuild.createdAt
- Defined in src/structures/extra/DiscordBase.ts:27

createdTimestamp

get createdTimestamp(): number
Create a timestamp for the current object.

Returns number
Inherited from AnonymousGuild.createdTimestamp
- Defined in src/structures/extra/DiscordBase.ts:20

partnered

get partnered(): boolean
Returns boolean
Inherited from AnonymousGuild.partnered
- Defined in src/structures/extra/BaseGuild.ts:14

shard

get shard(): Shard | undefined
Shard of the guild.

Returns Shard | undefined
Shard or undefined, if the client is not gateway based always undefined.
Inherited from AnonymousGuild.shard
- Defined in src/structures/extra/BaseGuild.ts:108

shardId

get shardId(): number
Shard ID of the guild.

Returns number
Shard ID or -1 if the client is not gateway based.
Inherited from AnonymousGuild.shardId
- Defined in src/structures/extra/BaseGuild.ts:94

verified

get verified(): boolean
If the guild is verified.

Returns boolean
Link
https://discord.com/developers/docs/resources/guild#guild-object-guild-features
Inherited from AnonymousGuild.verified
- Defined in src/structures/extra/BaseGuild.ts:25

Methods

bannerURL

bannerURL(options?: CDNUrlOptions): string | undefined
bannerURL gets the current guild banner as a string.
Parameters
- Optionaloptions: CDNUrlOptions
  Image options for the banner url.
Returns string | undefined
Banner url or void

Link
https://discord.com/developers/docs/reference#image-formatting
Inherited from AnonymousGuild.bannerURL
- Defined in src/structures/extra/BaseGuild.ts:84

fetch

fetch(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>
Fetch guild on API
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<Guild<"cached" | "api">>
Inherited from AnonymousGuild.fetch
- Defined in src/structures/extra/BaseGuild.ts:35
fetch(mode: "cache"): ReturnCache<Guild<"cached"> | undefined>
Fetch guild on API
Parameters
- mode: "cache"
Returns ReturnCache<Guild<"cached"> | undefined>
Inherited from AnonymousGuild.fetch
- Defined in src/structures/extra/BaseGuild.ts:36

iconURL

iconURL(options?: CDNUrlOptions): string | undefined
iconURL gets the current guild icon.
Parameters
- Optionaloptions: CDNUrlOptions
Returns string | undefined
Link
https://discord.com/developers/docs/reference#image-formatting
Inherited from AnonymousGuild.iconURL
- Defined in src/structures/extra/BaseGuild.ts:60

leave

leave(): Promise<void | undefined>
Leave the guild.

Returns Promise<void | undefined>
Inherited from AnonymousGuild.leave
- Defined in src/structures/extra/BaseGuild.ts:52

splashURL

splashURL(options?: CDNUrlOptions): string | undefined
splashURL gets the current guild splash as a string.
Parameters
- Optionaloptions: CDNUrlOptions
  Image options for the splash url.
Returns string | undefined
Splash url or void.

Link
https://discord.com/developers/docs/reference#image-formatting
Inherited from AnonymousGuild.splashURL
- Defined in src/structures/extra/BaseGuild.ts:72

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from AnonymousGuild.toString
- Defined in src/structures/extra/BaseGuild.ts:119

Class GuildPreview

Link

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GuildPreview

Properties

Optionalbanner

Readonlyclient

Optionaldescription

Optionalfeatures

icon

id

name

splash

OptionalvanityUrlCode

OptionalverificationLevel

OptionalwelcomeScreen

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

partnered

Returns boolean

shard

Returns Shard | undefined

shardId

Returns number

verified

Returns boolean

Link

Methods

bannerURL

Parameters

Returns string | undefined

Link

fetch

Parameters

Returns Promise<Guild<"cached" | "api">>

Parameters

Returns ReturnCache<Guild<"cached"> | undefined>

iconURL

Parameters

Returns string | undefined

Link

leave

Returns Promise<void | undefined>

splashURL

Parameters

Returns string | undefined

Link

toString

Returns string

Settings

On This Page

`Optional`banner

`Readonly`client

`Optional`description

`Optional`features

`Optional`vanityUrlCode

`Optional`verificationLevel

`Optional`welcomeScreen