Search
Preparing search index...
The search index is not available
Detritus Client
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Detritus Client
structures/guild
GuildMe
Class GuildMe
Guild Me Structure
Hierarchy
BaseGuild
GuildMe
Index
Constructors
constructor
Properties
_keys
client
features
icon
id
name
owner
permissions
Accessors
acronym
can
Have
Banner
can
Have
Discovery
Features
can
Have
News
can
Have
Public
can
Have
Splash
can
Have
Store
can
Have
Vanity
Url
can
Have
Vip
Regions
created
At
created
AtUnix
icon
Url
is
Clone
is
Discoverable
is
Partnered
is
Public
is
Verified
jump
Link
shard
Id
widget
Image
Url
widget
Url
Methods
[custom]
_get
From
Snake
_set
From
Snake
ack
add
Member
add
Member
Role
begin
Prune
can
clone
create
Ban
create
Channel
create
Emoji
create
Integration
create
Role
create
Sticker
create
Template
delete
delete
Channel
delete
Emoji
delete
Integration
delete
Premium
Subscription
delete
Role
delete
Sticker
delete
Template
difference
differences
differences
Between
edit
edit
Channel
edit
Channel
Positions
edit
Embed
edit
Emoji
edit
Integration
edit
Member
edit
Mfa
Level
edit
Nick
edit
Role
edit
Role
Positions
edit
Sticker
edit
Vanity
Url
edit
Voice
State
fetch
Applications
fetch
Audit
Logs
fetch
Bans
fetch
Channels
fetch
Embed
fetch
Emoji
fetch
Emojis
fetch
Integrations
fetch
Invites
fetch
Member
fetch
Members
fetch
Members
Search
fetch
Premium
Subscriptions
fetch
Prune
Count
fetch
Roles
fetch
Sticker
fetch
Stickers
fetch
Templates
fetch
Vanity
Url
fetch
Voice
Regions
fetch
Webhooks
fetch
Widget
fetch
Widget
Json
fetch
Widget
Png
has
Difference
has
Differences
has
Differences
Between
has
Feature
icon
Url
Format
join
leave
merge
merge
Value
remove
Ban
remove
Member
remove
Member
Role
request
Members
search
sync
Integration
toJSON
to
String
widget
Image
Url
Format
widget
Url
Format
Constructors
constructor
new
Guild
Me
(
client
:
ShardClient
, data
?:
BaseStructureData
, isClone
?:
boolean
)
:
GuildMe
Parameters
client:
ShardClient
Optional
data:
BaseStructureData
Optional
isClone:
boolean
Returns
GuildMe
Properties
Readonly
_keys
_keys
:
BaseSet
<
string
>
= ...
Readonly
client
client
:
ShardClient
features
features
:
BaseSet
<
string
>
= ...
icon
icon
:
null
|
string
= null
id
id
:
string
= ''
name
name
:
string
= ''
owner
owner
:
boolean
= false
permissions
permissions
:
bigint
= ...
Accessors
acronym
get
acronym
(
)
:
string
Returns
string
can
Have
Banner
get
canHaveBanner
(
)
:
boolean
Returns
boolean
can
Have
Discovery
Features
get
canHaveDiscoveryFeatures
(
)
:
boolean
Returns
boolean
can
Have
News
get
canHaveNews
(
)
:
boolean
Returns
boolean
can
Have
Public
get
canHavePublic
(
)
:
boolean
Returns
boolean
can
Have
Splash
get
canHaveSplash
(
)
:
boolean
Returns
boolean
can
Have
Store
get
canHaveStore
(
)
:
boolean
Returns
boolean
can
Have
Vanity
Url
get
canHaveVanityUrl
(
)
:
boolean
Returns
boolean
can
Have
Vip
Regions
get
canHaveVipRegions
(
)
:
boolean
Returns
boolean
created
At
get
createdAt
(
)
:
Date
Returns
Date
created
AtUnix
get
createdAtUnix
(
)
:
number
Returns
number
icon
Url
get
iconUrl
(
)
:
null
|
string
Returns
null
|
string
is
Clone
get
isClone
(
)
:
boolean
Returns
boolean
is
Discoverable
get
isDiscoverable
(
)
:
boolean
Returns
boolean
is
Partnered
get
isPartnered
(
)
:
boolean
Returns
boolean
is
Public
get
isPublic
(
)
:
boolean
Returns
boolean
is
Verified
get
isVerified
(
)
:
boolean
Returns
boolean
jump
Link
get
jumpLink
(
)
:
string
Returns
string
shard
Id
get
shardId
(
)
:
number
Returns
number
widget
Image
Url
get
widgetImageUrl
(
)
:
string
Returns
string
widget
Url
get
widgetUrl
(
)
:
string
Returns
string
Methods
[custom]
[custom]
(
)
:
object
Returns
object
_get
From
Snake
_get
From
Snake
(
key
:
string
)
:
any
Parameters
key:
string
Returns
any
_set
From
Snake
_set
From
Snake
(
key
:
string
, value
:
any
)
:
any
Parameters
key:
string
value:
any
Returns
any
ack
ack
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
add
Member
add
Member
(
userId
:
string
, options
:
AddGuildMember
)
:
Promise
<
any
>
Parameters
userId:
string
options:
AddGuildMember
Returns
Promise
<
any
>
add
Member
Role
add
Member
Role
(
userId
:
string
, roleId
:
string
)
:
Promise
<
any
>
Parameters
userId:
string
roleId:
string
Returns
Promise
<
any
>
begin
Prune
begin
Prune
(
options
?:
BeginGuildPrune
)
:
Promise
<
any
>
Parameters
options:
BeginGuildPrune
= {}
Returns
Promise
<
any
>
can
can
(
permissions
:
PermissionChecks
, options
?:
{
ignoreAdministrator
?:
boolean
;
ignoreOwner
?:
boolean
}
)
:
boolean
Parameters
permissions:
PermissionChecks
options:
{
ignoreAdministrator
?:
boolean
;
ignoreOwner
?:
boolean
}
= {}
Optional
ignore
Administrator
?:
boolean
Optional
ignore
Owner
?:
boolean
Returns
boolean
clone
clone
(
)
:
GuildMe
Returns
GuildMe
create
Ban
create
Ban
(
userId
:
string
, options
:
CreateGuildBan
)
:
Promise
<
any
>
Parameters
userId:
string
options:
CreateGuildBan
Returns
Promise
<
any
>
create
Channel
create
Channel
(
options
:
CreateGuildChannel
)
:
Promise
<
Channel
>
Parameters
options:
CreateGuildChannel
Returns
Promise
<
Channel
>
create
Emoji
create
Emoji
(
options
:
CreateGuildEmoji
)
:
Promise
<
Emoji
>
Parameters
options:
CreateGuildEmoji
Returns
Promise
<
Emoji
>
create
Integration
create
Integration
(
options
:
CreateGuildIntegration
)
:
Promise
<
any
>
Parameters
options:
CreateGuildIntegration
Returns
Promise
<
any
>
create
Role
create
Role
(
options
:
CreateGuildRole
)
:
Promise
<
Role
>
Parameters
options:
CreateGuildRole
Returns
Promise
<
Role
>
create
Sticker
create
Sticker
(
options
:
CreateGuildSticker
)
:
Promise
<
Sticker
>
Parameters
options:
CreateGuildSticker
Returns
Promise
<
Sticker
>
create
Template
create
Template
(
options
:
CreateGuildTemplate
)
:
Promise
<
Template
>
Parameters
options:
CreateGuildTemplate
Returns
Promise
<
Template
>
delete
delete
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
delete
Channel
delete
Channel
(
channelId
:
string
, options
?:
DeleteChannel
)
:
Promise
<
Channel
>
Parameters
channelId:
string
options:
DeleteChannel
= {}
Returns
Promise
<
Channel
>
delete
Emoji
delete
Emoji
(
emojiId
:
string
, options
?:
DeleteGuildEmoji
)
:
Promise
<
any
>
Parameters
emojiId:
string
options:
DeleteGuildEmoji
= {}
Returns
Promise
<
any
>
delete
Integration
delete
Integration
(
integrationId
:
string
, options
?:
DeleteGuildIntegration
)
:
Promise
<
any
>
Parameters
integrationId:
string
options:
DeleteGuildIntegration
= {}
Returns
Promise
<
any
>
delete
Premium
Subscription
delete
Premium
Subscription
(
subscriptionId
:
string
)
:
Promise
<
any
>
Parameters
subscriptionId:
string
Returns
Promise
<
any
>
delete
Role
delete
Role
(
roleId
:
string
, options
?:
DeleteGuildRole
)
:
Promise
<
any
>
Parameters
roleId:
string
options:
DeleteGuildRole
= {}
Returns
Promise
<
any
>
delete
Sticker
delete
Sticker
(
stickerId
:
string
)
:
Promise
<
any
>
Parameters
stickerId:
string
Returns
Promise
<
any
>
delete
Template
delete
Template
(
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
differences
(
data
?:
BaseStructureData
)
:
null
|
object
Parameters
Optional
data:
BaseStructureData
Returns
null
|
object
differences
Between
differences
Between
(
structure
:
Structure
)
:
null
|
object
Parameters
structure:
Structure
Returns
null
|
object
edit
edit
(
options
:
EditGuild
)
:
Promise
<
Guild
>
Parameters
options:
EditGuild
Returns
Promise
<
Guild
>
edit
Channel
edit
Channel
(
channelId
:
string
, options
:
EditChannel
)
:
Promise
<
Channel
>
Parameters
channelId:
string
options:
EditChannel
Returns
Promise
<
Channel
>
edit
Channel
Positions
edit
Channel
Positions
(
channels
:
EditGuildChannels
, options
?:
EditGuildChannelsExtra
)
:
Promise
<
any
>
Parameters
channels:
EditGuildChannels
options:
EditGuildChannelsExtra
= {}
Returns
Promise
<
any
>
edit
Embed
edit
Embed
(
options
:
EditGuildEmbed
)
:
Promise
<
any
>
Parameters
options:
EditGuildEmbed
Returns
Promise
<
any
>
edit
Emoji
edit
Emoji
(
emojiId
:
string
, options
:
EditGuildEmoji
)
:
Promise
<
Emoji
>
Parameters
emojiId:
string
options:
EditGuildEmoji
Returns
Promise
<
Emoji
>
edit
Integration
edit
Integration
(
integrationId
:
string
, options
:
EditGuildIntegration
)
:
Promise
<
any
>
Parameters
integrationId:
string
options:
EditGuildIntegration
Returns
Promise
<
any
>
edit
Member
edit
Member
(
userId
:
string
, options
:
EditGuildMember
)
:
Promise
<
any
>
Parameters
userId:
string
options:
EditGuildMember
Returns
Promise
<
any
>
edit
Mfa
Level
edit
Mfa
Level
(
options
:
EditGuildMfaLevel
)
:
Promise
<
any
>
Parameters
options:
EditGuildMfaLevel
Returns
Promise
<
any
>
edit
Nick
edit
Nick
(
nick
:
string
, options
?:
EditGuildNick
)
:
Promise
<
any
>
Parameters
nick:
string
options:
EditGuildNick
= {}
Returns
Promise
<
any
>
edit
Role
edit
Role
(
roleId
:
string
, options
:
EditGuildRole
)
:
Promise
<
Role
>
Parameters
roleId:
string
options:
EditGuildRole
Returns
Promise
<
Role
>
edit
Role
Positions
edit
Role
Positions
(
roles
:
EditGuildRolePositions
, options
?:
EditGuildRolePositionsExtra
)
:
Promise
<
BaseCollection
<
string
,
Role
>
>
Parameters
roles:
EditGuildRolePositions
options:
EditGuildRolePositionsExtra
= {}
Returns
Promise
<
BaseCollection
<
string
,
Role
>
>
edit
Sticker
edit
Sticker
(
stickerId
:
string
, options
?:
EditGuildSticker
)
:
Promise
<
Sticker
>
Parameters
stickerId:
string
options:
EditGuildSticker
= {}
Returns
Promise
<
Sticker
>
edit
Vanity
Url
edit
Vanity
Url
(
code
:
string
, options
?:
EditGuildVanity
)
:
Promise
<
any
>
Parameters
code:
string
options:
EditGuildVanity
= {}
Returns
Promise
<
any
>
edit
Voice
State
edit
Voice
State
(
userId
:
string
, options
:
EditGuildVoiceState
)
:
Promise
<
any
>
Parameters
userId:
string
options:
EditGuildVoiceState
Returns
Promise
<
any
>
fetch
Applications
fetch
Applications
(
channelId
?:
string
)
:
Promise
<
any
>
Parameters
Optional
channelId:
string
Returns
Promise
<
any
>
fetch
Audit
Logs
fetch
Audit
Logs
(
options
:
FetchGuildAuditLogs
)
:
Promise
<
BaseCollection
<
string
,
AuditLog
>
>
Parameters
options:
FetchGuildAuditLogs
Returns
Promise
<
BaseCollection
<
string
,
AuditLog
>
>
fetch
Bans
fetch
Bans
(
)
:
Promise
<
FetchGuildBans
>
Returns
Promise
<
FetchGuildBans
>
fetch
Channels
fetch
Channels
(
)
:
Promise
<
BaseCollection
<
string
,
Channel
>
>
Returns
Promise
<
BaseCollection
<
string
,
Channel
>
>
fetch
Embed
fetch
Embed
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
fetch
Emoji
fetch
Emoji
(
emojiId
:
string
)
:
Promise
<
Emoji
>
Parameters
emojiId:
string
Returns
Promise
<
Emoji
>
fetch
Emojis
fetch
Emojis
(
)
:
Promise
<
BaseCollection
<
string
,
Emoji
>
>
Returns
Promise
<
BaseCollection
<
string
,
Emoji
>
>
fetch
Integrations
fetch
Integrations
(
)
:
Promise
<
BaseCollection
<
string
,
Integration
>
>
Returns
Promise
<
BaseCollection
<
string
,
Integration
>
>
fetch
Invites
fetch
Invites
(
)
:
Promise
<
BaseCollection
<
string
,
Invite
>
>
Returns
Promise
<
BaseCollection
<
string
,
Invite
>
>
fetch
Member
fetch
Member
(
userId
:
string
)
:
Promise
<
Member
>
Parameters
userId:
string
Returns
Promise
<
Member
>
fetch
Members
fetch
Members
(
options
:
FetchGuildMembers
)
:
Promise
<
BaseCollection
<
string
,
Member
>
>
Parameters
options:
FetchGuildMembers
Returns
Promise
<
BaseCollection
<
string
,
Member
>
>
fetch
Members
Search
fetch
Members
Search
(
options
:
FetchGuildMembersSearch
)
:
Promise
<
BaseCollection
<
string
,
Member
>
>
Parameters
options:
FetchGuildMembersSearch
Returns
Promise
<
BaseCollection
<
string
,
Member
>
>
fetch
Premium
Subscriptions
fetch
Premium
Subscriptions
(
)
:
Promise
<
BaseCollection
<
string
,
PremiumSubscription
>
>
Returns
Promise
<
BaseCollection
<
string
,
PremiumSubscription
>
>
fetch
Prune
Count
fetch
Prune
Count
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
fetch
Roles
fetch
Roles
(
)
:
Promise
<
BaseCollection
<
string
,
Role
>
>
Returns
Promise
<
BaseCollection
<
string
,
Role
>
>
fetch
Sticker
fetch
Sticker
(
stickerId
:
string
)
:
Promise
<
Sticker
>
Parameters
stickerId:
string
Returns
Promise
<
Sticker
>
fetch
Stickers
fetch
Stickers
(
)
:
Promise
<
BaseCollection
<
string
,
Sticker
>
>
Returns
Promise
<
BaseCollection
<
string
,
Sticker
>
>
fetch
Templates
fetch
Templates
(
)
:
Promise
<
BaseCollection
<
string
,
Template
>
>
Returns
Promise
<
BaseCollection
<
string
,
Template
>
>
fetch
Vanity
Url
fetch
Vanity
Url
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
fetch
Voice
Regions
fetch
Voice
Regions
(
)
:
Promise
<
BaseCollection
<
string
,
VoiceRegion
>
>
Returns
Promise
<
BaseCollection
<
string
,
VoiceRegion
>
>
fetch
Webhooks
fetch
Webhooks
(
)
:
Promise
<
BaseCollection
<
string
,
Webhook
>
>
Returns
Promise
<
BaseCollection
<
string
,
Webhook
>
>
fetch
Widget
fetch
Widget
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
fetch
Widget
Json
fetch
Widget
Json
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
fetch
Widget
Png
fetch
Widget
Png
(
options
?:
FetchGuildWidgetPng
)
:
Promise
<
any
>
Parameters
options:
FetchGuildWidgetPng
= {}
Returns
Promise
<
any
>
has
Difference
has
Difference
(
key
:
string
, value
:
any
)
:
boolean
Parameters
key:
string
value:
any
Returns
boolean
has
Differences
has
Differences
(
data
?:
BaseStructureData
)
:
boolean
Parameters
Optional
data:
BaseStructureData
Returns
boolean
has
Differences
Between
has
Differences
Between
(
structure
:
Structure
)
:
boolean
Parameters
structure:
Structure
Returns
boolean
has
Feature
has
Feature
(
feature
:
string
)
:
boolean
Parameters
feature:
string
Returns
boolean
icon
Url
Format
icon
Url
Format
(
format
?:
null
|
string
, query
?:
UrlQuery
)
:
null
|
string
Parameters
Optional
format:
null
|
string
Optional
query:
UrlQuery
Returns
null
|
string
join
join
(
options
:
JoinGuild
)
:
Promise
<
any
>
Parameters
options:
JoinGuild
Returns
Promise
<
any
>
leave
leave
(
)
:
Promise
<
any
>
Returns
Promise
<
any
>
merge
merge
(
data
?:
BaseStructureData
)
:
void
Parameters
Optional
data:
BaseStructureData
Returns
void
merge
Value
merge
Value
(
key
:
string
, value
:
any
)
:
void
Parameters
key:
string
value:
any
Returns
void
remove
Ban
remove
Ban
(
userId
:
string
, options
?:
RemoveGuildBan
)
:
Promise
<
any
>
Parameters
userId:
string
options:
RemoveGuildBan
= {}
Returns
Promise
<
any
>
remove
Member
remove
Member
(
userId
:
string
, options
?:
RemoveGuildMember
)
:
Promise
<
any
>
Parameters
userId:
string
options:
RemoveGuildMember
= {}
Returns
Promise
<
any
>
remove
Member
Role
remove
Member
Role
(
userId
:
string
, roleId
:
string
, options
?:
RemoveGuildBan
)
:
Promise
<
any
>
Parameters
userId:
string
roleId:
string
options:
RemoveGuildBan
= {}
Returns
Promise
<
any
>
request
Members
request
Members
(
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
>
}
>
Parameters
options:
{
limit
?:
number
;
presences
?:
boolean
;
query
:
string
;
timeout
?:
number
;
userIds
?:
string
[]
}
Optional
limit
?:
number
Optional
presences
?:
boolean
query
:
string
Optional
timeout
?:
number
Optional
user
Ids
?:
string
[]
Returns
Promise
<
{
members
:
BaseCollection
<
string
,
Member
>
;
nonce
:
string
;
notFound
:
BaseSet
<
string
>
;
presences
:
BaseCollection
<
string
,
Presence
>
}
>
search
search
(
options
:
SearchOptions
, retry
?:
boolean
)
:
Promise
<
any
>
Parameters
options:
SearchOptions
Optional
retry:
boolean
Returns
Promise
<
any
>
sync
Integration
sync
Integration
(
integrationId
:
string
)
:
Promise
<
any
>
Parameters
integrationId:
string
Returns
Promise
<
any
>
toJSON
toJSON
(
)
:
object
Returns
object
to
String
to
String
(
)
:
string
Returns
string
widget
Image
Url
Format
widget
Image
Url
Format
(
query
?:
UrlQuery
)
:
string
Parameters
Optional
query:
UrlQuery
Returns
string
widget
Url
Format
widget
Url
Format
(
options
?:
RouteWidget
)
:
string
Parameters
options:
RouteWidget
= {}
Returns
string
Exports
structures/guild
Base
Guild
Guild
Guild
Me
constructor
_keys
client
features
icon
id
name
owner
permissions
acronym
can
Have
Banner
can
Have
Discovery
Features
can
Have
News
can
Have
Public
can
Have
Splash
can
Have
Store
can
Have
Vanity
Url
can
Have
Vip
Regions
created
At
created
AtUnix
icon
Url
is
Clone
is
Discoverable
is
Partnered
is
Public
is
Verified
jump
Link
shard
Id
widget
Image
Url
widget
Url
[custom]
_get
From
Snake
_set
From
Snake
ack
add
Member
add
Member
Role
begin
Prune
can
clone
create
Ban
create
Channel
create
Emoji
create
Integration
create
Role
create
Sticker
create
Template
delete
delete
Channel
delete
Emoji
delete
Integration
delete
Premium
Subscription
delete
Role
delete
Sticker
delete
Template
difference
differences
differences
Between
edit
edit
Channel
edit
Channel
Positions
edit
Embed
edit
Emoji
edit
Integration
edit
Member
edit
Mfa
Level
edit
Nick
edit
Role
edit
Role
Positions
edit
Sticker
edit
Vanity
Url
edit
Voice
State
fetch
Applications
fetch
Audit
Logs
fetch
Bans
fetch
Channels
fetch
Embed
fetch
Emoji
fetch
Emojis
fetch
Integrations
fetch
Invites
fetch
Member
fetch
Members
fetch
Members
Search
fetch
Premium
Subscriptions
fetch
Prune
Count
fetch
Roles
fetch
Sticker
fetch
Stickers
fetch
Templates
fetch
Vanity
Url
fetch
Voice
Regions
fetch
Webhooks
fetch
Widget
fetch
Widget
Json
fetch
Widget
Png
has
Difference
has
Differences
has
Differences
Between
has
Feature
icon
Url
Format
join
leave
merge
merge
Value
remove
Ban
remove
Member
remove
Member
Role
request
Members
search
sync
Integration
toJSON
to
String
widget
Image
Url
Format
widget
Url
Format
Guild
Partial
Guild
Welcome
Screen
Guild
Welcome
Screen
Channel
Generated using
TypeDoc
Guild Me Structure