Documentation

Contents

Enums

LibraryActionName

Methods

_buildURL 🅿
accountLogin
accountRegister
accountReset
accountRestore
apps
dmChannel
dmFavorites
dmFavoritesChannel
dmMessage
dmRequests
friends
gift
giftWithLogin
guild
guildChannel
guildDiscovery
guildEvent
guildHomeChannel
guildHubMembershipScreening
guildMembershipScreening
guildMessage
guildRoleSubscriptions
guildSettingsAnalytics
guildSettingsAppDirectory
guildSettingsAuditLog
guildSettingsBans
guildSettingsCommunity
guildSettingsCommunityWelcome
guildSettingsDelete
guildSettingsDiscovery
guildSettingsEmoji
guildSettingsGuildPremium
guildSettingsGuildTemplates
guildSettingsInstantInvites
guildSettingsIntegrations
guildSettingsMemberVerification
guildSettingsMembers
guildSettingsModeration
guildSettingsOnboarding
guildSettingsOverview
guildSettingsPartner
guildSettingsRoles
guildSettingsRoleSubscriptions
guildSettingsStickers
guildSettingsVanityURL
guildSettingsWidget
home
library
libraryInventory
libraryItemActions
librarySettings
newServer
serverInvite
serverInviteWithLogin
store
storePageApplication ⚠️
storePageSKU ⚠️
userProfile
userSettingsAccessiblility
userSettingsAccount
userSettingsActivityPrivacy
userSettingsAdvanced
userSettingsAppearance
userSettingsAuthorizedApps
userSettingsBilling
userSettingsChangelogs
userSettingsConnections
userSettingsDeveloperOptions
userSettingsDismissableContentOptions
userSettingsExperiments
userSettingsFriendRequests
userSettingsHotspotOptions
userSettingsHypesquadOnline
userSettingsInventory
userSettingsKeybinds
userSettingsLinux
userSettingsLocale
userSettingsNotifications
userSettingsOverlay
userSettingsPremium
userSettingsPremiumGuildSubscription
userSettingsPrivacyAndSafety
userSettingsProfileCustomization
userSettingsRegisteredGames
userSettingsStreamerMode
userSettingsSubscriptions
userSettingsText
userSettingsVoice
userSettingsWindows

Properties

baseURL 🔐

Enums

LibraryActionName

The base URL to use for the protocol

Key	Value
Launch	launch

Methods

._buildURL(url, clickable) 🅿

Private - Builds all URLs

Parameter	Type	Optional	Default Value	Description
url	String	❌	none	URL to build
clickable	Boolean	❌	none	If true, will build a link that will be clickable in Discord

Returns: String
The given URL as a string, optionally with clickable markdown

.accountLogin(redirectTo, discordClickable)

Goes to the account login page, and optionally will redirect to a specific URL

• Link format: discord://-/login
• Link format with redirection: discord://-/login?redirect_to=<redirectTo>

Parameter	Type	Optional	Default Value	Description
redirectTo	String	✔️	none	If supplied, when the user logs in, they will be redirected to the specified URL
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.accountRegister(redirectTo, discordClickable)

Goes to the account registration page, and optionally will redirect to a specific URL

• Link format: discord://-/register
• Link format with redirection: discord://-/register?redirect_to=<redirectTo>

Parameter	Type	Optional	Default Value	Description
redirectTo	String	✔️	none	If supplied, when the user registers, they will be redirected to the specified URL
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.accountReset(discordClickable)

Goes to the user's reset account page

• Link format: discord://-/reset

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.accountRestore(discordClickable)

Goes to the user's restore account page

• Link format: discord://-/restore

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.apps(discordClickable)

Goes to the apps page

• Link format: discord://-/apps

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.dmChannel(channelId, discordClickable)

Goes to the specified DM channel

• Link format: discord://-/channels/@me/<channelId>

Parameter	Type	Optional	Default Value	Description
channelId	String	❌	none	The channel ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.dmFavorites(discordClickable)

Goes to the user's favorites page

• Link format: discord://-/channels/@favorites

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.dmFavoritesChannel(channelId, discordClickable)

Goes to the specified channel in the user's favorites page

• Link format: discord://-/channels/@favorites/<channelId>

Parameter	Type	Optional	Default Value	Description
channelId	String	❌	none	The channel ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.dmMessage(channelId, messageId, discordClickable)

Goes to the specified message, in the specified DM channel

• Link format: discord://-/channels/@me/<channelId>/<messageId>

Parameter	Type	Optional	Default Value	Description
channelId	String	❌	none	The channel ID to use
messageId	String	❌	none	The message ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.dmRequests(discordClickable)

Goes to the user's message requests page

• Link format: discord://-/message-requests

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.friends(discordClickable)

Goes to the friends page

• Link format: discord://-/channels/@me

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.gift(giftCode, discordClickable)

Goes to the gift redemption page

• Link format: discord://-/gifts/<giftCode>

Parameter	Type	Optional	Default Value	Description
giftCode	String	❌	none	The gift code to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.giftWithLogin(giftCode, discordClickable)

Goes to the gift redemption page, with a login prompt

• Link format: discord://-/gifts/<giftCode>/login

Parameter	Type	Optional	Default Value	Description
giftCode	String	❌	none	The gift code to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guild(guildId, discordClickable)

Goes to the specified guild

• Link format: discord://-/channels/<guildId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildChannel(guildId, channelId, discordClickable)

Goes to the specified channel, in the specified guild

• Link format: discord://-/channels/<guildId>/<channelId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
channelId	String	❌	none	The channel ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildDiscovery(discordClickable)

Goes to the guild discovery page

• Link format: discord://-/guild-discovery

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildEvent(guildId, eventId, discordClickable)

Goes to the specified event, in the specified guild

• Link format: discord://-/channels/<guildId>/<eventId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
eventId	String	❌	none	The event ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildHomeChannel(guildId, discordClickable)

Goes to the specified guild's home channel

• Link format: discord://-/channels/<guildId>/@home

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildHubMembershipScreening(guildId, discordClickable)

Goes to the specified guild hub's membership screening page

• Link format: discord://-/member-verification-for-hub/<guildId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildMembershipScreening(guildId, discordClickable)

Goes to the specified guild's membership screening page

• Link format: discord://-/member-verification/<guildId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildMessage(guildId, channelId, messageId, discordClickable)

Goes to the specified message, in the specified channel, in the specified guild

• Link format: discord://-/channels/<guildId>/<channelId>/<messageId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
channelId	String	❌	none	The channel ID to use
messageId	String	❌	none	The message ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildRoleSubscriptions(guildId, discordClickable)

Goes to the specified guild's role subscriptions page

• Link format: discord://-/guild-role-subscriptions/<guildId>

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsAnalytics(guildId, discordClickable)

Goes to the specified guild's analytics settings page

• Link format: discord://-/guilds/<guildId>/settings/analytics

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsAppDirectory(guildId, discordClickable)

Goes to the specified guild's app directory settings page

• Link format: discord://-/guilds/<guildId>/settings/app-directory

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsAuditLog(guildId, discordClickable)

Goes to the specified guild's audit log settings page

• Link format: discord://-/guilds/<guildId>/settings/audit-log

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsBans(guildId, discordClickable)

Goes to the specified guild's bans settings page

• Link format: discord://-/guilds/<guildId>/settings/bans

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsCommunity(guildId, discordClickable)

Goes to the specified guild's community settings page

• Link format: discord://-/guilds/<guildId>/settings/community

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsCommunityWelcome(guildId, discordClickable)

Goes to the specified guild's community welcome settings page

• Link format: discord://-/guilds/<guildId>/settings/community-welcome

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsDelete(guildId, discordClickable)

Goes to the specified guild's delete settings page

• Link format: discord://-/guilds/<guildId>/settings/delete

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsDiscovery(guildId, discordClickable)

Goes to the specified guild's discovery settings page

• Link format: discord://-/guilds/<guildId>/settingsdiscovery/

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsEmoji(guildId, discordClickable)

Goes to the specified guild's emoji settings page

• Link format: discord://-/guilds/<guildId>/settings/emoji

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsGuildPremium(guildId, discordClickable)

Goes to the specified guild's premium (nitro server boosts) settings page

• Link format: discord://-/guilds/<guildId>/settings/guild-premium

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsGuildTemplates(guildId, discordClickable)

Goes to the specified guild's guild templates settings page

• Link format: discord://-/guilds/<guildId>/settings/guild-templates

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsInstantInvites(guildId, discordClickable)

Goes to the specified guild's instant invites settings page

• Link format: discord://-/guilds/<guildId>/settings/instant-invites

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsIntegrations(guildId, discordClickable)

Goes to the specified guild's integrations settings page

• Link format: discord://-/guilds/<guildId>/settings/integrations

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsMemberVerification(guildId, discordClickable)

Goes to the specified guild's member verification settings page

• Link format: discord://-/guilds/<guildId>/settings/member-verification

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsMembers(guildId, discordClickable)

Goes to the specified guild's members settings page

• Link format: discord://-/guilds/<guildId>/settings/members

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsModeration(guildId, discordClickable)

Goes to the specified guild's moderation settings page

• Link format: discord://-/guilds/<guildId>/settings/moderation

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsOnboarding(guildId, discordClickable)

Goes to the specified guild's onboarding settings page

• Link format: discord://-/guilds/<guildId>/settings/onboarding

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsOverview(guildId, discordClickable)

Goes to the specified guild's overview settings page

• Link format: discord://-/guilds/<guildId>/settings/overview

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsPartner(guildId, discordClickable)

Goes to the specified guild's partner settings page

• Link format: discord://-/guilds/<guildId>/settings/partner

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsRoles(guildId, discordClickable)

Goes to the specified guild's roles settings page

• Link format: discord://-/guilds/<guildId>/settings/roles

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsRoleSubscriptions(guildId, discordClickable)

Goes to the specified guild's role subscriptions settings page

• Link format: discord://-/guilds/<guildId>/settings/role-subscriptions

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsStickers(guildId, discordClickable)

Goes to the specified guild's stickers settings page

• Link format: discord://-/guilds/<guildId>/settings/stickers

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsVanityURL(guildId, discordClickable)

Goes to the specified guild's vanity URL settings page

• Link format: discord://-/guilds/<guildId>/settings/vanity-url

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.guildSettingsWidget(guildId, discordClickable)

Goes to the specified guild's widget settings page

• Link format: discord://-/guilds/<guildId>/settings/widget

Parameter	Type	Optional	Default Value	Description
guildId	String	❌	none	The guild ID to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.home(discordClickable)

Goes to the home page

• Link format: discord://-/

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.library(discordClickable)

Goes to the user's library

• Link format: discord://-/library

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.libraryInventory(discordClickable)

Goes to the user's library inventory

• Link format: discord://-/library/inventory

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.libraryItemActions(skuId, actionType, discordClickable)

Goes to the user's library inventory

• Link format: discord://-/library/inventory

Parameter	Type	Optional	Default Value	Description
skuId	String	❌	none	The SKU id to use
actionType	String<keyof LibraryActionName>	✔️	none	If provided, will perform the specified action on the specified SKU
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.librarySettings(discordClickable)

Goes to the user's library settings

• Link format: discord://-/library/settings

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.newServer(discordClickable)

Goes to new server creation page

• Link format: discord://-/guilds/create

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.serverInvite(inviteCode, discordClickable)

Goes to new server creation page

• Link format: discord://-/invite/<inviteCode>

Parameter	Type	Optional	Default Value	Description
inviteCode	String	❌	none	The invite code to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.serverInviteWithLogin(inviteCode, discordClickable)

Goes to new server creation page

• Link format: discord://-/invite/<inviteCode>/login

Parameter	Type	Optional	Default Value	Description
inviteCode	String	❌	none	The invite code to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.store(discordClickable)

Goes to the store page

• Link format: discord://-/store

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.storePageApplication(applicationId, discordClickable) ⚠️

DEPRECATED: Discord has removed support for the store, thus this URL no longer works!

Goes to the specified application's store page

• Link format: discord://-/store/applications/<applicationId>

Parameter	Type	Optional	Default Value	Description
applicationId	String	❌	none	The application id to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.storePageSKU(skuId, discordClickable) ⚠️

DEPRECATED: Discord has removed support for the store, thus this URL no longer works!

Goes to the specified SKU's store page

• Link format: discord://-/store/skus/<skuId>

Parameter	Type	Optional	Default Value	Description
skuId	String	❌	none	The SKU id to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userProfile(userId, discordClickable)

Goes to the specified user's profile popout

• Link format: discord://-/users/<userId>

Parameter	Type	Optional	Default Value	Description
userId	String	❌	none	The user id to use
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsAccessibility(discordClickable)

Goes to the user's accessibility settings page

• Link format: discord://-/settings/accessibility

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsAccount(discordClickable)

Goes to the user's account settings page

• Link format: discord://-/settings/account

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsActivityPrivacy(discordClickable)

Goes to the user's activity privacy settings page

• Link format: discord://-/settings/activity-privacy

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsAdvanced(discordClickable)

Goes to the user's advanced settings page

• Link format: discord://-/settings/advanced

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsAppearance(discordClickable)

Goes to the user's appearance settings page

• Link format: discord://-/settings/appearance

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsAuthorizedApps(discordClickable)

Goes to the user's authorized apps settings page

• Link format: discord://-/settings/authorized-apps

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsBilling(discordClickable)

Goes to the user's billing settings page

• Link format: discord://-/settings/billing

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsChangelogs(discordClickable)

Goes to the user's changelogs settings page

• Link format: discord://-/settings/changelogs

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsConnections(discordClickable)

Goes to the user's connections settings page

• Link format: discord://-/settings/connections

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsDeveloperOptions(discordClickable)

Goes to the user's developer options settings page

• Link format: discord://-/settings/developer-options

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsDismissableContentOptions(discordClickable)

Goes to the user's dismissable content options settings page

• Link format: discord://-/settings/dismissable-content-options

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsExperiments(discordClickable)

Goes to the user's experiments settings page

• Link format: discord://-/settings/experiments

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsFriendRequests(discordClickable)

Goes to the user's friend requests settings page

• Link format: discord://-/settings/friend-requests

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsHotspotOptions(discordClickable)

Goes to the user's hotspot options settings page

• Link format: discord://-/settings/hotspot-options

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsHypesquadOnline(discordClickable)

Goes to the user's hypesquad online settings page

• Link format: discord://-/settings/hypesquad-online

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsInventory(discordClickable)

Goes to the user's inventory (gift inventory) settings page

• Link format: discord://-/settings/inventory

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsKeybinds(discordClickable)

Goes to the user's keybinds settings page

• Link format: discord://-/settings/keybinds

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsLinux(discordClickable)

Goes to the user's linux (OS-specific; not always present) settings page

• Link format: discord://-/settings/linux

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsLocale(discordClickable)

Goes to the user's locale (language) settings page

• Link format: discord://-/settings/locale

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsNotifications(discordClickable)

Goes to the user's notifications settings page

• Link format: discord://-/settings/notifications

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsOverlay(discordClickable)

Goes to the user's overlay settings page

• Link format: discord://-/settings/overlay

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsPremium(discordClickable)

Goes to the specified guild's premium (nitro server boosts) settings page

• Link format: discord://-/settings/premium

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsPremiumGuildSubscription(discordClickable)

Goes to the user's premium guild subscription (nitro server boosts) settings page

• Link format: discord://-/settings/premium-guild-subscription

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsPrivacyAndSafety(discordClickable)

Goes to the user's privacy and safety settings page

• Link format: discord://-/settings/privacy-and-safety

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsProfileCustomization(discordClickable)

Goes to the user's profile customization settings page

• Link format: discord://-/settings/profile-customization

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsRegisteredGames(discordClickable)

Goes to the user's registered games settings page

• Link format: discord://-/settings/registered-games

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsStreamerMode(discordClickable)

Goes to the user's streamer mode settings page

• Link format: discord://-/settings/streamer-mode

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsSubscriptions(discordClickable)

Goes to the user's subscriptions settings page

• Link format: discord://-/settings/subscriptions

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsText(discordClickable)

Goes to the user's text (text & images) settings page

• Link format: discord://-/settings/text

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsVoice(discordClickable)

Goes to the user's voice (voice & video) settings page

• Link format: discord://-/settings/voice

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

.userSettingsWindows(discordClickable)

Goes to the user's windows (OS-specific; not always present) settings page

• Link format: discord://-/settings/windows

Parameter	Type	Optional	Default Value	Description
discordClickable	Boolean	✔️	false	If true, will build a link that will be clickable in Discord

Returns: String
The URL as a string, optionally with clickable markdown

Properties

.baseURL 🔐

The base URL to use for the protocol
Type: String

Note: This property is read-only.