Preparing search index...
The search index is not available

Settings

Member Visibility

Inherited
External

Theme

Oceanic
Routes
GUILD_PREVIEW

Function GUILD_PREVIEW

GUILD_PREVIEW(guildID): `/guilds/${string}/preview`
Parameters
- guildID: string
Returns `/guilds/${string}/preview`
- Defined in lib/util/Routes.ts:28

Constants
Routes
Types/ApplicationCommands
Types/AuditLog
Types/AutoModeration
Types/Channels
Types/Client
Types/Gateway
Types/Gateway/Raw
Types/GuildTemplate
Types/Guilds
Types/Index
Types/Interactions
Types/JSON
Types/Miscellaneous
Types/OAuth
Types/RequestHandler
Types/ScheduledEvents
Types/Shared
Types/Users
Types/Voice
Types/Webhooks
AnnouncementChannel
Represents a guild announcement channel.
AnnouncementThreadChannel
Represents a public thread channel in an announcement channel.
Application
Represents an application.
ApplicationCommand
Represents an application command.
Attachment
Represents a file attachment.
AuditLogEntry
Represents a guild audit log entry.
AutoModerationRule
Represents an auto moderation rule.
AutocompleteInteraction
Represents an autocomplete interaction.
Base
A base class which most other classes extend.
Bucket
A bucket.
CategoryChannel
Represents a guild category channel.
Channel
Represents a channel.
Client
The primary class for interfacing with Discord. See Client Events for a list of events.
ClientApplication
A representation of the authorized client's application (typically received via gateway).
Collection
A Map with some Array-like additions.
CommandInteraction
Represents a command interaction.
ComponentInteraction
Represents a component interaction.
DependencyError
An error encountered when a needed dependency is missing.
DiscordHTTPError
An HTTP error received from Discord.
DiscordRESTError
A REST error received from Discord.
ExtendedUser
Represents the currently authenticated user.
ForumChannel
Represents a thread forum channel.
GatewayError
A gateway error.
GroupChannel
Represents a group direct message.
Guild
Represents a Discord server.
GuildChannel
Represents a guild channel.
GuildPreview
Represents a preview of a guild.
GuildScheduledEvent
Represents a guild scheduled event.
GuildTemplate
Represents a guild template.
Integration
Represents a guild integration.
Interaction
Represents an interaction.
InteractionOptionsWrapper
A wrapper for interaction options.
InteractionResolvedChannel
Represents a channel from an interaction option. This can be any guild channel, or a direct message.
Invite
Represents an invite.
InviteGuild
Represents a guild received via an invite.
MediaChannel
Represents a media channel.
Member
Represents a member of a guild.
Message
Represents a message.
ModalSubmitInteraction
Represents a modal submit interaction.
OAuthApplication
Represents an oauth application.
OAuthGuild
Represents a guild retrieved via oauth.
OAuthHelper
A helper to make using authenticated oauth requests without needing a new client instance.
PartialApplication
Represents a partial application.
Permission
Represents a permission.
PermissionOverwrite
Represents a permission overwrite.
PingInteraction
Represents a PING interaction. This will not be received over a gateway connection.
PrivateChannel
Represents a direct message with a user.
PrivateThreadChannel
Represents a private thread channel..
PublicThreadChannel
Represents a public thread channel.
REST/ApplicationCommands
Various methods for interacting with application commands. Located at Client#rest.applicationCommands.
REST/Channels
Various methods for interacting with channels. Located at Client#rest.channels.
REST/Guilds
Various methods for interacting with guilds. Located at Client#rest.guilds.
REST/Interactions
Various methods for interacting with interactions. Located at Client#rest.interactions.
REST/Miscellaneous
Methods that don't fit anywhere else. Located at Client#rest.misc.
REST/OAuth
Various methods for interacting with oauth. Located at Client#rest.oauth.
REST/Users
Various methods for interacting with users. Located at Client#rest.users.
REST/Webhooks
Various methods for interacting with webhooks. Located at Client#rest.webhooks.
RESTManager
A manager for all rest actions.
RequestHandler
The primary means of communicating with Discord via rest.
Role
Represents a role in a guild.
SelectMenuValuesWrapper
A wrapper for select menu data.
SequentialBucket
A ratelimit bucket.
Shard
Represents a gateway connection to Discord. See Shard Events for a list of events.
ShardManager
A manager for all the client's shards.
SimpleCollection
This is an internal class, you should not use it in your projects. If you want a collection type for your own projects, look at Collection.
StageChannel
Represents a guild stage channel.
StageInstance
Represents a stage instance.
Team
Represents an OAuth team.
TextChannel
Represents a guild text channel.
TextableChannel
Represents a guild textable channel.
TextableVoiceChannel
Represents a textable voice channel.
ThreadChannel
Represents a guild thread channel.
ThreadOnlyChannel
Represents a thread only channel.
ThreadableChannel
Represents a guild textable channel.
TypedCollection
This is an internal class, you should not use it in your projects. If you want a collection type for your own projects, look at Collection.
TypedEmitter
UnavailableGuild
Represents a guild that is unavailable.
UncachedError
An error ancountered when an object is unexpectedly not cached.
UncaughtError
An error that is thrown when we encounter an error, and no `error` listeners are present.
User
Represents a user.
Util
A general set of utilities. These are intentionally poorly documented, as they serve almost no usefulness to outside developers.
VoiceChannel
Represents a guild voice channel.
VoiceState
Represents a guild member's voice state.
Webhook
Represents a webhook.
WrapperError
An error encountered within InteractionOptionsWrapper & SelectMenuValuesWrapper.
ClientEvents
ExtraOptions
ShardEvents