Search
Preparing search index...
The search index is not available
yuuko
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
yuuko
Eris
CommandClient
Class CommandClient
Hierarchy
Client
CommandClient
Index
Constructors
constructor
Properties
bot
channel
Guild
Map
commands
gatewayURL
group
Channels
guild
Shard
Map
guilds
notes
on
options
private
Channel
Map
private
Channels
relationships
shards
start
Time
token
unavailable
Guilds
uptime
user
user
Guild
Settings
user
Settings
users
voice
Connections
default
Max
Listeners
Methods
accept
Invite
add
Group
Recipient
add
Guild
Member
Role
add
Listener
add
Message
Reaction
add
Relationship
add
Self
Premium
Subscription
ban
Guild
Member
close
Voice
Connection
connect
create
Channel
create
Channel
Invite
create
Channel
Webhook
create
Group
Channel
create
Guild
create
Guild
Emoji
create
Message
create
Role
crosspost
Message
delete
Channel
delete
Channel
Permission
delete
Guild
delete
Guild
Emoji
delete
Guild
Integration
delete
Invite
delete
Message
delete
Messages
delete
Role
delete
Self
Connection
delete
Self
Premium
Subscription
delete
User
Note
delete
Webhook
disable
SelfMFATOTP
disconnect
editAFK
edit
Channel
edit
Channel
Permission
edit
Channel
Position
edit
Guild
edit
Guild
Emoji
edit
Guild
Integration
edit
Guild
Member
edit
Message
edit
Nickname
edit
Role
edit
Role
Position
edit
Self
edit
Self
Connection
edit
Self
Settings
edit
Status
edit
User
Note
edit
Webhook
emit
enable
SelfMFATOTP
event
Names
execute
Slack
Webhook
execute
Webhook
follow
Channel
get
Bot
Gateway
get
Channel
get
Channel
Invites
get
Channel
Webhooks
getDMChannel
get
Gateway
get
Guild
Audit
Logs
get
Guild
Ban
get
Guild
Bans
get
Guild
Embed
get
Guild
Integrations
get
Guild
Invites
get
Guild
Preview
get
Guild
Vanity
get
Guild
Webhooks
get
Invite
get
Max
Listeners
get
Message
get
Message
Reaction
get
Messages
getOAuth
Application
get
Pins
get
Prune
Count
getRESTChannel
getRESTGuild
getRESTGuild
Channels
getRESTGuild
Emoji
getRESTGuild
Emojis
getRESTGuild
Member
getRESTGuild
Members
getRESTGuild
Roles
getRESTGuilds
getRESTUser
get
Self
get
Self
Billing
get
Self
Connections
get
SelfMFACodes
get
Self
Payments
get
Self
Settings
get
User
Profile
get
Voice
Regions
get
Webhook
join
Voice
Channel
kick
Guild
Member
leave
Guild
leave
Voice
Channel
listener
Count
listeners
off
on
Message
Create
once
pin
Message
prepend
Listener
prepend
Once
Listener
prune
Members
purge
Channel
raw
Listeners
register
Command
register
Command
Alias
register
Guild
Prefix
remove
All
Listeners
remove
Group
Recipient
remove
Guild
Member
Role
remove
Listener
remove
Message
Reaction
remove
Message
Reaction
Emoji
remove
Message
Reactions
remove
Relationship
search
Channel
Messages
search
Guild
Members
search
Guild
Messages
send
Channel
Typing
set
Max
Listeners
sync
Guild
Integration
toJSON
to
String
unban
Guild
Member
unpin
Message
unregister
Command
listener
Count
Constructors
constructor
new
Command
Client
(
token
:
string
, options
?:
ClientOptions
, commandOptions
?:
CommandClientOptions
)
:
CommandClient
Parameters
token:
string
Optional
options:
ClientOptions
Optional
commandOptions:
CommandClientOptions
Returns
CommandClient
Properties
Optional
bot
bot
:
undefined
|
boolean
channel
Guild
Map
channel
Guild
Map
:
{}
Type declaration
[
s:
string
]:
string
commands
commands
:
{}
Type declaration
[
s:
string
]:
Command
Optional
gatewayURL
gatewayURL
:
undefined
|
string
group
Channels
group
Channels
:
Collection
<
GroupChannel
>
guild
Shard
Map
guild
Shard
Map
:
{}
Type declaration
[
s:
string
]:
number
guilds
guilds
:
Collection
<
Guild
>
notes
notes
:
{}
Type declaration
[
s:
string
]:
string
on
on
:
ClientEvents
<
CommandClient
>
options
options
:
ClientOptions
private
Channel
Map
private
Channel
Map
:
{}
Type declaration
[
s:
string
]:
string
private
Channels
private
Channels
:
Collection
<
PrivateChannel
>
relationships
relationships
:
Collection
<
Relationship
>
shards
shards
:
ShardManager
start
Time
start
Time
:
number
Optional
token
token
:
undefined
|
string
unavailable
Guilds
unavailable
Guilds
:
Collection
<
UnavailableGuild
>
uptime
uptime
:
number
user
user
:
ExtendedUser
user
Guild
Settings
user
Guild
Settings
:
{}
Type declaration
[
s:
string
]:
GuildSettings
user
Settings
user
Settings
:
UserSettings
users
users
:
Collection
<
User
>
voice
Connections
voice
Connections
:
Collection
<
VoiceConnection
>
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
accept
Invite
accept
Invite
(
inviteID
:
string
)
:
Promise
<
RESTInvite
>
Parameters
inviteID:
string
Returns
Promise
<
RESTInvite
>
add
Group
Recipient
add
Group
Recipient
(
groupID
:
string
, userID
:
string
)
:
Promise
<
void
>
Parameters
groupID:
string
userID:
string
Returns
Promise
<
void
>
add
Guild
Member
Role
add
Guild
Member
Role
(
guildID
:
string
, memberID
:
string
, roleID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
memberID:
string
roleID:
string
Optional
reason:
string
Returns
Promise
<
void
>
add
Listener
add
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
CommandClient
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
CommandClient
add
Message
Reaction
add
Message
Reaction
(
channelID
:
string
, messageID
:
string
, reaction
:
string
, userID
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
reaction:
string
Optional
userID:
string
Returns
Promise
<
void
>
add
Relationship
add
Relationship
(
userID
:
string
, block
?:
boolean
)
:
Promise
<
void
>
Parameters
userID:
string
Optional
block:
boolean
Returns
Promise
<
void
>
add
Self
Premium
Subscription
add
Self
Premium
Subscription
(
token
:
string
, plan
:
string
)
:
Promise
<
void
>
Parameters
token:
string
plan:
string
Returns
Promise
<
void
>
ban
Guild
Member
ban
Guild
Member
(
guildID
:
string
, userID
:
string
, deleteMessageDays
?:
number
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
userID:
string
Optional
deleteMessageDays:
number
Optional
reason:
string
Returns
Promise
<
void
>
close
Voice
Connection
close
Voice
Connection
(
guildID
:
string
)
:
void
Parameters
guildID:
string
Returns
void
connect
connect
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
create
Channel
create
Channel
(
guildID
:
string
, name
:
string
)
:
Promise
<
TextChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
:
0
, reason
?:
string
, options
?:
string
|
CreateChannelOptions
)
:
Promise
<
TextChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
:
2
, reason
?:
string
, options
?:
string
|
CreateChannelOptions
)
:
Promise
<
VoiceChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
:
4
, reason
?:
string
, options
?:
string
|
CreateChannelOptions
)
:
Promise
<
CategoryChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
?:
number
, reason
?:
string
, options
?:
string
|
CreateChannelOptions
)
:
Promise
<
unknown
>
create
Channel
(
guildID
:
string
, name
:
string
, type
:
0
, options
?:
CreateChannelOptions
)
:
Promise
<
TextChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
:
2
, options
?:
CreateChannelOptions
)
:
Promise
<
VoiceChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
:
4
, options
?:
CreateChannelOptions
)
:
Promise
<
CategoryChannel
>
create
Channel
(
guildID
:
string
, name
:
string
, type
?:
number
, options
?:
CreateChannelOptions
)
:
Promise
<
unknown
>
Parameters
guildID:
string
name:
string
Returns
Promise
<
TextChannel
>
Parameters
guildID:
string
name:
string
type:
0
Optional
reason:
string
Optional
options:
string
|
CreateChannelOptions
Returns
Promise
<
TextChannel
>
Parameters
guildID:
string
name:
string
type:
2
Optional
reason:
string
Optional
options:
string
|
CreateChannelOptions
Returns
Promise
<
VoiceChannel
>
Parameters
guildID:
string
name:
string
type:
4
Optional
reason:
string
Optional
options:
string
|
CreateChannelOptions
Returns
Promise
<
CategoryChannel
>
Parameters
guildID:
string
name:
string
Optional
type:
number
Optional
reason:
string
Optional
options:
string
|
CreateChannelOptions
Returns
Promise
<
unknown
>
Parameters
guildID:
string
name:
string
type:
0
Optional
options:
CreateChannelOptions
Returns
Promise
<
TextChannel
>
Parameters
guildID:
string
name:
string
type:
2
Optional
options:
CreateChannelOptions
Returns
Promise
<
VoiceChannel
>
Parameters
guildID:
string
name:
string
type:
4
Optional
options:
CreateChannelOptions
Returns
Promise
<
CategoryChannel
>
Parameters
guildID:
string
name:
string
Optional
type:
number
Optional
options:
CreateChannelOptions
Returns
Promise
<
unknown
>
create
Channel
Invite
create
Channel
Invite
(
channelID
:
string
, options
?:
{
maxAge
?:
undefined
|
number
;
maxUses
?:
undefined
|
number
;
temporary
?:
undefined
|
boolean
;
unique
?:
undefined
|
boolean
}
, reason
?:
string
)
:
Promise
<
ChannelInvite
>
Parameters
channelID:
string
Optional
options:
{
maxAge
?:
undefined
|
number
;
maxUses
?:
undefined
|
number
;
temporary
?:
undefined
|
boolean
;
unique
?:
undefined
|
boolean
}
Optional
max
Age
?:
undefined
|
number
Optional
max
Uses
?:
undefined
|
number
Optional
temporary
?:
undefined
|
boolean
Optional
unique
?:
undefined
|
boolean
Optional
reason:
string
Returns
Promise
<
ChannelInvite
>
create
Channel
Webhook
create
Channel
Webhook
(
channelID
:
string
, options
:
{
avatar
:
string
;
name
:
string
}
, reason
?:
string
)
:
Promise
<
Webhook
>
Parameters
channelID:
string
options:
{
avatar
:
string
;
name
:
string
}
avatar
:
string
name
:
string
Optional
reason:
string
Returns
Promise
<
Webhook
>
create
Group
Channel
create
Group
Channel
(
userIDs
:
string
[]
)
:
Promise
<
GroupChannel
>
Parameters
userIDs:
string
[]
Returns
Promise
<
GroupChannel
>
create
Guild
create
Guild
(
name
:
string
, options
?:
CreateGuildOptions
)
:
Promise
<
Guild
>
Parameters
name:
string
Optional
options:
CreateGuildOptions
Returns
Promise
<
Guild
>
create
Guild
Emoji
create
Guild
Emoji
(
guildID
:
string
, options
:
EmojiOptions
, reason
?:
string
)
:
Promise
<
Emoji
>
Parameters
guildID:
string
options:
EmojiOptions
Optional
reason:
string
Returns
Promise
<
Emoji
>
create
Message
create
Message<T>
(
channelID
:
string
, content
:
MessageContent
, file
?:
MessageFile
|
MessageFile
[]
)
:
Promise
<
Message
<
T
>
>
Type parameters
T
:
Textable
=
TextableChannel
Parameters
channelID:
string
content:
MessageContent
Optional
file:
MessageFile
|
MessageFile
[]
Returns
Promise
<
Message
<
T
>
>
create
Role
create
Role
(
guildID
:
string
, options
?:
RoleOptions
|
Role
, reason
?:
string
)
:
Promise
<
Role
>
Parameters
guildID:
string
Optional
options:
RoleOptions
|
Role
Optional
reason:
string
Returns
Promise
<
Role
>
crosspost
Message
crosspost
Message
(
channelID
:
string
, messageID
:
string
)
:
Promise
<
Message
<
TextableChannel
>
>
Parameters
channelID:
string
messageID:
string
Returns
Promise
<
Message
<
TextableChannel
>
>
delete
Channel
delete
Channel
(
channelID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
Optional
reason:
string
Returns
Promise
<
void
>
delete
Channel
Permission
delete
Channel
Permission
(
channelID
:
string
, overwriteID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
overwriteID:
string
Optional
reason:
string
Returns
Promise
<
void
>
delete
Guild
delete
Guild
(
guildID
:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
Returns
Promise
<
void
>
delete
Guild
Emoji
delete
Guild
Emoji
(
guildID
:
string
, emojiID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
emojiID:
string
Optional
reason:
string
Returns
Promise
<
void
>
delete
Guild
Integration
delete
Guild
Integration
(
guildID
:
string
, integrationID
:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
integrationID:
string
Returns
Promise
<
void
>
delete
Invite
delete
Invite
(
inviteID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
inviteID:
string
Optional
reason:
string
Returns
Promise
<
void
>
delete
Message
delete
Message
(
channelID
:
string
, messageID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
Optional
reason:
string
Returns
Promise
<
void
>
delete
Messages
delete
Messages
(
channelID
:
string
, messageIDs
:
string
[]
, reason
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageIDs:
string
[]
Optional
reason:
string
Returns
Promise
<
void
>
delete
Role
delete
Role
(
guildID
:
string
, roleID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
roleID:
string
Optional
reason:
string
Returns
Promise
<
void
>
delete
Self
Connection
delete
Self
Connection
(
platform
:
string
, id
:
string
)
:
Promise
<
void
>
Parameters
platform:
string
id:
string
Returns
Promise
<
void
>
delete
Self
Premium
Subscription
delete
Self
Premium
Subscription
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
User
Note
delete
User
Note
(
userID
:
string
)
:
Promise
<
void
>
Parameters
userID:
string
Returns
Promise
<
void
>
delete
Webhook
delete
Webhook
(
webhookID
:
string
, token
?:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
webhookID:
string
Optional
token:
string
Optional
reason:
string
Returns
Promise
<
void
>
disable
SelfMFATOTP
disable
SelfMFATOTP
(
code
:
string
)
:
Promise
<
{
token
:
string
}
>
Parameters
code:
string
Returns
Promise
<
{
token
:
string
}
>
disconnect
disconnect
(
options
:
{
reconnect
:
boolean
}
)
:
void
Parameters
options:
{
reconnect
:
boolean
}
reconnect
:
boolean
Returns
void
editAFK
editAFK
(
afk
:
boolean
)
:
void
Parameters
afk:
boolean
Returns
void
edit
Channel
edit
Channel
(
channelID
:
string
, options
:
{
bitrate
?:
undefined
|
number
;
icon
?:
undefined
|
string
;
name
?:
undefined
|
string
;
nsfw
?:
undefined
|
boolean
;
ownerID
?:
undefined
|
string
;
parentID
?:
undefined
|
string
;
rateLimitPerUser
?:
undefined
|
number
;
topic
?:
undefined
|
string
;
userLimit
?:
undefined
|
number
}
, reason
?:
string
)
:
Promise
<
TextChannel
|
NewsChannel
|
VoiceChannel
|
CategoryChannel
|
StoreChannel
|
GroupChannel
>
Parameters
channelID:
string
options:
{
bitrate
?:
undefined
|
number
;
icon
?:
undefined
|
string
;
name
?:
undefined
|
string
;
nsfw
?:
undefined
|
boolean
;
ownerID
?:
undefined
|
string
;
parentID
?:
undefined
|
string
;
rateLimitPerUser
?:
undefined
|
number
;
topic
?:
undefined
|
string
;
userLimit
?:
undefined
|
number
}
Optional
bitrate
?:
undefined
|
number
Optional
icon
?:
undefined
|
string
Optional
name
?:
undefined
|
string
Optional
nsfw
?:
undefined
|
boolean
Optional
ownerID
?:
undefined
|
string
Optional
parentID
?:
undefined
|
string
Optional
rate
Limit
Per
User
?:
undefined
|
number
Optional
topic
?:
undefined
|
string
Optional
user
Limit
?:
undefined
|
number
Optional
reason:
string
Returns
Promise
<
TextChannel
|
NewsChannel
|
VoiceChannel
|
CategoryChannel
|
StoreChannel
|
GroupChannel
>
edit
Channel
Permission
edit
Channel
Permission
(
channelID
:
string
, overwriteID
:
string
, allow
:
number
, deny
:
number
, type
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
overwriteID:
string
allow:
number
deny:
number
type:
string
Optional
reason:
string
Returns
Promise
<
void
>
edit
Channel
Position
edit
Channel
Position
(
channelID
:
string
, position
:
number
)
:
Promise
<
void
>
Parameters
channelID:
string
position:
number
Returns
Promise
<
void
>
edit
Guild
edit
Guild
(
guildID
:
string
, options
:
GuildOptions
, reason
?:
string
)
:
Promise
<
Guild
>
Parameters
guildID:
string
options:
GuildOptions
Optional
reason:
string
Returns
Promise
<
Guild
>
edit
Guild
Emoji
edit
Guild
Emoji
(
guildID
:
string
, emojiID
:
string
, options
:
{
name
?:
undefined
|
string
;
roles
?:
undefined
|
string
[]
}
, reason
?:
string
)
:
Promise
<
Emoji
>
Parameters
guildID:
string
emojiID:
string
options:
{
name
?:
undefined
|
string
;
roles
?:
undefined
|
string
[]
}
Optional
name
?:
undefined
|
string
Optional
roles
?:
undefined
|
string
[]
Optional
reason:
string
Returns
Promise
<
Emoji
>
edit
Guild
Integration
edit
Guild
Integration
(
guildID
:
string
, integrationID
:
string
, options
:
IntegrationOptions
)
:
Promise
<
void
>
Parameters
guildID:
string
integrationID:
string
options:
IntegrationOptions
Returns
Promise
<
void
>
edit
Guild
Member
edit
Guild
Member
(
guildID
:
string
, memberID
:
string
, options
:
MemberOptions
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
memberID:
string
options:
MemberOptions
Optional
reason:
string
Returns
Promise
<
void
>
edit
Message
edit
Message
(
channelID
:
string
, messageID
:
string
, content
:
MessageContent
)
:
Promise
<
Message
<
TextableChannel
>
>
Parameters
channelID:
string
messageID:
string
content:
MessageContent
Returns
Promise
<
Message
<
TextableChannel
>
>
edit
Nickname
edit
Nickname
(
guildID
:
string
, nick
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
nick:
string
Optional
reason:
string
Returns
Promise
<
void
>
edit
Role
edit
Role
(
guildID
:
string
, roleID
:
string
, options
:
RoleOptions
, reason
?:
string
)
:
Promise
<
Role
>
Parameters
guildID:
string
roleID:
string
options:
RoleOptions
Optional
reason:
string
Returns
Promise
<
Role
>
edit
Role
Position
edit
Role
Position
(
guildID
:
string
, roleID
:
string
, position
:
number
)
:
Promise
<
void
>
Parameters
guildID:
string
roleID:
string
position:
number
Returns
Promise
<
void
>
edit
Self
edit
Self
(
options
:
{
avatar
?:
undefined
|
string
;
username
?:
undefined
|
string
}
)
:
Promise
<
ExtendedUser
>
Parameters
options:
{
avatar
?:
undefined
|
string
;
username
?:
undefined
|
string
}
Optional
avatar
?:
undefined
|
string
Optional
username
?:
undefined
|
string
Returns
Promise
<
ExtendedUser
>
edit
Self
Connection
edit
Self
Connection
(
platform
:
string
, id
:
string
, data
:
{
friendSync
:
boolean
;
visibility
:
number
}
)
:
Promise
<
Connection
>
Parameters
platform:
string
id:
string
data:
{
friendSync
:
boolean
;
visibility
:
number
}
friend
Sync
:
boolean
visibility
:
number
Returns
Promise
<
Connection
>
edit
Self
Settings
edit
Self
Settings
(
data
:
UserSettings
)
:
Promise
<
UserSettings
>
Parameters
data:
UserSettings
Returns
Promise
<
UserSettings
>
edit
Status
edit
Status
(
status
?:
"online"
|
"idle"
|
"dnd"
|
"offline"
, game
?:
ActivityPartial
<
BotActivityType
>
)
:
void
Parameters
Optional
status:
"online"
|
"idle"
|
"dnd"
|
"offline"
Optional
game:
ActivityPartial
<
BotActivityType
>
Returns
void
edit
User
Note
edit
User
Note
(
userID
:
string
, note
:
string
)
:
Promise
<
void
>
Parameters
userID:
string
note:
string
Returns
Promise
<
void
>
edit
Webhook
edit
Webhook
(
webhookID
:
string
, options
:
{
avatar
?:
undefined
|
string
;
name
?:
undefined
|
string
}
, token
?:
string
, reason
?:
string
)
:
Promise
<
Webhook
>
Parameters
webhookID:
string
options:
{
avatar
?:
undefined
|
string
;
name
?:
undefined
|
string
}
Optional
avatar
?:
undefined
|
string
Optional
name
?:
undefined
|
string
Optional
token:
string
Optional
reason:
string
Returns
Promise
<
Webhook
>
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
enable
SelfMFATOTP
enable
SelfMFATOTP
(
secret
:
string
, code
:
string
)
:
Promise
<
{
backup_codes
:
{
code
:
string
;
consumed
:
boolean
}
[]
;
token
:
string
}
>
Parameters
secret:
string
code:
string
Returns
Promise
<
{
backup_codes
:
{
code
:
string
;
consumed
:
boolean
}
[]
;
token
:
string
}
>
event
Names
event
Names
(
)
:
(
string
|
symbol
)
[]
Returns
(
string
|
symbol
)
[]
execute
Slack
Webhook
execute
Slack
Webhook
(
webhookID
:
string
, token
:
string
, options
?:
{
auth
?:
undefined
|
boolean
;
wait
?:
undefined
|
boolean
}
)
:
Promise
<
void
>
Parameters
webhookID:
string
token:
string
Optional
options:
{
auth
?:
undefined
|
boolean
;
wait
?:
undefined
|
boolean
}
Optional
auth
?:
undefined
|
boolean
Optional
wait
?:
undefined
|
boolean
Returns
Promise
<
void
>
execute
Webhook
execute
Webhook
(
webhookID
:
string
, token
:
string
, options
:
WebhookPayload
&
{
wait
:
true
}
)
:
Promise
<
Message
<
TextableChannel
>
>
execute
Webhook
(
webhookID
:
string
, token
:
string
, options
:
WebhookPayload
)
:
Promise
<
void
>
Parameters
webhookID:
string
token:
string
options:
WebhookPayload
&
{
wait
:
true
}
Returns
Promise
<
Message
<
TextableChannel
>
>
Parameters
webhookID:
string
token:
string
options:
WebhookPayload
Returns
Promise
<
void
>
follow
Channel
follow
Channel
(
channelID
:
string
, webhookChannelID
:
string
)
:
Promise
<
ChannelFollow
>
Parameters
channelID:
string
webhookChannelID:
string
Returns
Promise
<
ChannelFollow
>
get
Bot
Gateway
get
Bot
Gateway
(
)
:
Promise
<
{
session_start_limit
:
{
remaining
:
number
;
reset_after
:
number
;
total
:
number
}
;
shards
:
number
;
url
:
string
}
>
Returns
Promise
<
{
session_start_limit
:
{
remaining
:
number
;
reset_after
:
number
;
total
:
number
}
;
shards
:
number
;
url
:
string
}
>
get
Channel
get
Channel
(
channelID
:
string
)
:
AnyChannel
Parameters
channelID:
string
Returns
AnyChannel
get
Channel
Invites
get
Channel
Invites
(
channelID
:
string
)
:
Promise
<
ChannelInvite
[]
>
Parameters
channelID:
string
Returns
Promise
<
ChannelInvite
[]
>
get
Channel
Webhooks
get
Channel
Webhooks
(
channelID
:
string
)
:
Promise
<
Webhook
[]
>
Parameters
channelID:
string
Returns
Promise
<
Webhook
[]
>
getDMChannel
getDMChannel
(
userID
:
string
)
:
Promise
<
PrivateChannel
>
Parameters
userID:
string
Returns
Promise
<
PrivateChannel
>
get
Gateway
get
Gateway
(
)
:
Promise
<
{
url
:
string
}
>
Returns
Promise
<
{
url
:
string
}
>
get
Guild
Audit
Logs
get
Guild
Audit
Logs
(
guildID
:
string
, limit
?:
number
, before
?:
string
, actionType
?:
number
)
:
Promise
<
GuildAuditLog
>
Parameters
guildID:
string
Optional
limit:
number
Optional
before:
string
Optional
actionType:
number
Returns
Promise
<
GuildAuditLog
>
get
Guild
Ban
get
Guild
Ban
(
guildID
:
string
, userID
:
string
)
:
Promise
<
{
reason
?:
undefined
|
string
;
user
:
User
}
>
Parameters
guildID:
string
userID:
string
Returns
Promise
<
{
reason
?:
undefined
|
string
;
user
:
User
}
>
get
Guild
Bans
get
Guild
Bans
(
guildID
:
string
)
:
Promise
<
{
reason
?:
undefined
|
string
;
user
:
User
}
[]
>
Parameters
guildID:
string
Returns
Promise
<
{
reason
?:
undefined
|
string
;
user
:
User
}
[]
>
get
Guild
Embed
get
Guild
Embed
(
guildID
:
string
)
:
Promise
<
GuildEmbed
>
Parameters
guildID:
string
Returns
Promise
<
GuildEmbed
>
get
Guild
Integrations
get
Guild
Integrations
(
guildID
:
string
)
:
Promise
<
GuildIntegration
[]
>
Parameters
guildID:
string
Returns
Promise
<
GuildIntegration
[]
>
get
Guild
Invites
get
Guild
Invites
(
guildID
:
string
)
:
Promise
<
ChannelInvite
[]
>
Parameters
guildID:
string
Returns
Promise
<
ChannelInvite
[]
>
get
Guild
Preview
get
Guild
Preview
(
guildID
:
string
)
:
Promise
<
GuildPreview
>
Parameters
guildID:
string
Returns
Promise
<
GuildPreview
>
get
Guild
Vanity
get
Guild
Vanity
(
guildID
:
string
)
:
Promise
<
{
code
?:
undefined
|
string
;
uses
?:
undefined
|
number
}
>
Parameters
guildID:
string
Returns
Promise
<
{
code
?:
undefined
|
string
;
uses
?:
undefined
|
number
}
>
get
Guild
Webhooks
get
Guild
Webhooks
(
guildID
:
string
)
:
Promise
<
Webhook
[]
>
Parameters
guildID:
string
Returns
Promise
<
Webhook
[]
>
get
Invite
get
Invite
(
inviteID
:
string
, withCounts
?:
boolean
)
:
Promise
<
RESTInvite
>
Parameters
inviteID:
string
Optional
withCounts:
boolean
Returns
Promise
<
RESTInvite
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
get
Message
get
Message
(
channelID
:
string
, messageID
:
string
)
:
Promise
<
Message
<
TextableChannel
>
>
Parameters
channelID:
string
messageID:
string
Returns
Promise
<
Message
<
TextableChannel
>
>
get
Message
Reaction
get
Message
Reaction
(
channelID
:
string
, messageID
:
string
, reaction
:
string
, limit
?:
number
, before
?:
string
, after
?:
string
)
:
Promise
<
User
[]
>
Parameters
channelID:
string
messageID:
string
reaction:
string
Optional
limit:
number
Optional
before:
string
Optional
after:
string
Returns
Promise
<
User
[]
>
get
Messages
get
Messages
(
channelID
:
string
, limit
?:
number
, before
?:
string
, after
?:
string
, around
?:
string
)
:
Promise
<
Message
<
TextableChannel
>
[]
>
Parameters
channelID:
string
Optional
limit:
number
Optional
before:
string
Optional
after:
string
Optional
around:
string
Returns
Promise
<
Message
<
TextableChannel
>
[]
>
getOAuth
Application
getOAuth
Application
(
appID
?:
string
)
:
Promise
<
OAuthApplicationInfo
>
Parameters
Optional
appID:
string
Returns
Promise
<
OAuthApplicationInfo
>
get
Pins
get
Pins
(
channelID
:
string
)
:
Promise
<
Message
<
TextableChannel
>
[]
>
Parameters
channelID:
string
Returns
Promise
<
Message
<
TextableChannel
>
[]
>
get
Prune
Count
get
Prune
Count
(
guildID
:
string
, options
?:
GetPruneOptions
)
:
Promise
<
number
>
Parameters
guildID:
string
Optional
options:
GetPruneOptions
Returns
Promise
<
number
>
getRESTChannel
getRESTChannel
(
channelID
:
string
)
:
Promise
<
AnyChannel
>
Parameters
channelID:
string
Returns
Promise
<
AnyChannel
>
getRESTGuild
getRESTGuild
(
guildID
:
string
, withCounts
?:
boolean
)
:
Promise
<
Guild
>
Parameters
guildID:
string
Optional
withCounts:
boolean
Returns
Promise
<
Guild
>
getRESTGuild
Channels
getRESTGuild
Channels
(
guildID
:
string
)
:
Promise
<
AnyGuildChannel
[]
>
Parameters
guildID:
string
Returns
Promise
<
AnyGuildChannel
[]
>
getRESTGuild
Emoji
getRESTGuild
Emoji
(
guildID
:
string
, emojiID
:
string
)
:
Promise
<
Emoji
>
Parameters
guildID:
string
emojiID:
string
Returns
Promise
<
Emoji
>
getRESTGuild
Emojis
getRESTGuild
Emojis
(
guildID
:
string
)
:
Promise
<
Emoji
[]
>
Parameters
guildID:
string
Returns
Promise
<
Emoji
[]
>
getRESTGuild
Member
getRESTGuild
Member
(
guildID
:
string
, memberID
:
string
)
:
Promise
<
Member
>
Parameters
guildID:
string
memberID:
string
Returns
Promise
<
Member
>
getRESTGuild
Members
getRESTGuild
Members
(
guildID
:
string
, limit
?:
number
, after
?:
string
)
:
Promise
<
Member
[]
>
Parameters
guildID:
string
Optional
limit:
number
Optional
after:
string
Returns
Promise
<
Member
[]
>
getRESTGuild
Roles
getRESTGuild
Roles
(
guildID
:
string
)
:
Promise
<
Role
[]
>
Parameters
guildID:
string
Returns
Promise
<
Role
[]
>
getRESTGuilds
getRESTGuilds
(
limit
?:
number
, before
?:
string
, after
?:
string
)
:
Promise
<
Guild
[]
>
Parameters
Optional
limit:
number
Optional
before:
string
Optional
after:
string
Returns
Promise
<
Guild
[]
>
getRESTUser
getRESTUser
(
userID
:
string
)
:
Promise
<
User
>
Parameters
userID:
string
Returns
Promise
<
User
>
get
Self
get
Self
(
)
:
Promise
<
ExtendedUser
>
Returns
Promise
<
ExtendedUser
>
get
Self
Billing
get
Self
Billing
(
)
:
Promise
<
{
payment_gateway
?:
undefined
|
string
;
payment_source
?:
undefined
|
{
brand
:
string
;
expires_month
:
number
;
expires_year
:
number
;
invalid
:
boolean
;
last_4
:
number
;
type
:
string
}
;
premium_subscription
?:
undefined
|
{
canceled_at
?:
undefined
|
string
;
created_at
:
string
;
current_period_end
?:
undefined
|
string
;
current_period_start
?:
undefined
|
string
;
ended_at
?:
undefined
|
string
;
plan
:
string
;
status
:
number
}
}
>
Returns
Promise
<
{
payment_gateway
?:
undefined
|
string
;
payment_source
?:
undefined
|
{
brand
:
string
;
expires_month
:
number
;
expires_year
:
number
;
invalid
:
boolean
;
last_4
:
number
;
type
:
string
}
;
premium_subscription
?:
undefined
|
{
canceled_at
?:
undefined
|
string
;
created_at
:
string
;
current_period_end
?:
undefined
|
string
;
current_period_start
?:
undefined
|
string
;
ended_at
?:
undefined
|
string
;
plan
:
string
;
status
:
number
}
}
>
get
Self
Connections
get
Self
Connections
(
)
:
Promise
<
Connection
[]
>
Returns
Promise
<
Connection
[]
>
get
SelfMFACodes
get
SelfMFACodes
(
password
:
string
, regenerate
?:
boolean
)
:
Promise
<
{
backup_codes
:
{
code
:
string
;
consumed
:
boolean
}
[]
}
>
Parameters
password:
string
Optional
regenerate:
boolean
Returns
Promise
<
{
backup_codes
:
{
code
:
string
;
consumed
:
boolean
}
[]
}
>
get
Self
Payments
get
Self
Payments
(
)
:
Promise
<
{
amount
:
number
;
amount_refunded
:
number
;
created_at
:
string
;
currency
:
string
;
description
:
string
;
status
:
number
}
[]
>
Returns
Promise
<
{
amount
:
number
;
amount_refunded
:
number
;
created_at
:
string
;
currency
:
string
;
description
:
string
;
status
:
number
}
[]
>
get
Self
Settings
get
Self
Settings
(
)
:
Promise
<
UserSettings
>
Returns
Promise
<
UserSettings
>
get
User
Profile
get
User
Profile
(
userID
:
string
)
:
Promise
<
UserProfile
>
Parameters
userID:
string
Returns
Promise
<
UserProfile
>
get
Voice
Regions
get
Voice
Regions
(
guildID
:
string
)
:
Promise
<
VoiceRegion
[]
>
Parameters
guildID:
string
Returns
Promise
<
VoiceRegion
[]
>
get
Webhook
get
Webhook
(
webhookID
:
string
, token
?:
string
)
:
Promise
<
Webhook
>
Parameters
webhookID:
string
Optional
token:
string
Returns
Promise
<
Webhook
>
join
Voice
Channel
join
Voice
Channel
(
channelID
:
string
, options
?:
{
opusOnly
?:
undefined
|
boolean
;
shared
?:
undefined
|
boolean
}
)
:
Promise
<
VoiceConnection
>
Parameters
channelID:
string
Optional
options:
{
opusOnly
?:
undefined
|
boolean
;
shared
?:
undefined
|
boolean
}
Optional
opus
Only
?:
undefined
|
boolean
Optional
shared
?:
undefined
|
boolean
Returns
Promise
<
VoiceConnection
>
kick
Guild
Member
kick
Guild
Member
(
guildID
:
string
, userID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
userID:
string
Optional
reason:
string
Returns
Promise
<
void
>
leave
Guild
leave
Guild
(
guildID
:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
Returns
Promise
<
void
>
leave
Voice
Channel
leave
Voice
Channel
(
channelID
:
string
)
:
void
Parameters
channelID:
string
Returns
void
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
off
off
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
CommandClient
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
CommandClient
on
Message
Create
on
Message
Create
(
msg
:
Message
<
TextableChannel
>
)
:
void
Parameters
msg:
Message
<
TextableChannel
>
Returns
void
once
once
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
CommandClient
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
CommandClient
pin
Message
pin
Message
(
channelID
:
string
, messageID
:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
Returns
Promise
<
void
>
prepend
Listener
prepend
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
CommandClient
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
CommandClient
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
CommandClient
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
CommandClient
prune
Members
prune
Members
(
guildID
:
string
, options
?:
PruneMemberOptions
)
:
Promise
<
number
>
Parameters
guildID:
string
Optional
options:
PruneMemberOptions
Returns
Promise
<
number
>
purge
Channel
purge
Channel
(
channelID
:
string
, limit
?:
number
, filter
?:
(
m
:
Message
<
TextableChannel
>
)
=>
boolean
, before
?:
string
, after
?:
string
, reason
?:
string
)
:
Promise
<
number
>
Parameters
channelID:
string
Optional
limit:
number
Optional
filter:
(
m
:
Message
<
TextableChannel
>
)
=>
boolean
(
m
:
Message
<
TextableChannel
>
)
:
boolean
Parameters
m:
Message
<
TextableChannel
>
Returns
boolean
Optional
before:
string
Optional
after:
string
Optional
reason:
string
Returns
Promise
<
number
>
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
register
Command
register
Command
(
label
:
string
, generator
:
CommandGenerator
, options
?:
CommandOptions
)
:
Command
Parameters
label:
string
generator:
CommandGenerator
Optional
options:
CommandOptions
Returns
Command
register
Command
Alias
register
Command
Alias
(
alias
:
string
, label
:
string
)
:
void
Parameters
alias:
string
label:
string
Returns
void
register
Guild
Prefix
register
Guild
Prefix
(
guildID
:
string
, prefix
:
string
|
string
[]
)
:
void
Parameters
guildID:
string
prefix:
string
|
string
[]
Returns
void
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
CommandClient
Parameters
Optional
event:
string
|
symbol
Returns
CommandClient
remove
Group
Recipient
remove
Group
Recipient
(
groupID
:
string
, userID
:
string
)
:
Promise
<
void
>
Parameters
groupID:
string
userID:
string
Returns
Promise
<
void
>
remove
Guild
Member
Role
remove
Guild
Member
Role
(
guildID
:
string
, memberID
:
string
, roleID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
memberID:
string
roleID:
string
Optional
reason:
string
Returns
Promise
<
void
>
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
CommandClient
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
CommandClient
remove
Message
Reaction
remove
Message
Reaction
(
channelID
:
string
, messageID
:
string
, reaction
:
string
, userID
?:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
reaction:
string
Optional
userID:
string
Returns
Promise
<
void
>
remove
Message
Reaction
Emoji
remove
Message
Reaction
Emoji
(
channelID
:
string
, messageID
:
string
, reaction
:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
reaction:
string
Returns
Promise
<
void
>
remove
Message
Reactions
remove
Message
Reactions
(
channelID
:
string
, messageID
:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
Returns
Promise
<
void
>
remove
Relationship
remove
Relationship
(
userID
:
string
)
:
Promise
<
void
>
Parameters
userID:
string
Returns
Promise
<
void
>
search
Channel
Messages
search
Channel
Messages
(
channelID
:
string
, query
:
SearchOptions
)
:
Promise
<
SearchResults
>
Parameters
channelID:
string
query:
SearchOptions
Returns
Promise
<
SearchResults
>
search
Guild
Members
search
Guild
Members
(
guildID
:
string
, query
:
string
, limit
?:
number
)
:
Promise
<
Member
[]
>
Parameters
guildID:
string
query:
string
Optional
limit:
number
Returns
Promise
<
Member
[]
>
search
Guild
Messages
search
Guild
Messages
(
guildID
:
string
, query
:
SearchOptions
)
:
Promise
<
SearchResults
>
Parameters
guildID:
string
query:
SearchOptions
Returns
Promise
<
SearchResults
>
send
Channel
Typing
send
Channel
Typing
(
channelID
:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
Returns
Promise
<
void
>
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
CommandClient
Parameters
n:
number
Returns
CommandClient
sync
Guild
Integration
sync
Guild
Integration
(
guildID
:
string
, integrationID
:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
integrationID:
string
Returns
Promise
<
void
>
toJSON
toJSON
(
props
?:
string
[]
)
:
JSONCache
Parameters
Optional
props:
string
[]
Returns
JSONCache
to
String
to
String
(
)
:
string
Returns
string
unban
Guild
Member
unban
Guild
Member
(
guildID
:
string
, userID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
guildID:
string
userID:
string
Optional
reason:
string
Returns
Promise
<
void
>
unpin
Message
unpin
Message
(
channelID
:
string
, messageID
:
string
)
:
Promise
<
void
>
Parameters
channelID:
string
messageID:
string
Returns
Promise
<
void
>
unregister
Command
unregister
Command
(
label
:
string
)
:
void
Parameters
label:
string
Returns
void
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
deprecated
since v4.0.0
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Exports
Externals
Eris
Command
Client
constructor
bot
channel
Guild
Map
commands
gatewayURL
group
Channels
guild
Shard
Map
guilds
notes
on
options
private
Channel
Map
private
Channels
relationships
shards
start
Time
token
unavailable
Guilds
uptime
user
user
Guild
Settings
user
Settings
users
voice
Connections
default
Max
Listeners
accept
Invite
add
Group
Recipient
add
Guild
Member
Role
add
Listener
add
Message
Reaction
add
Relationship
add
Self
Premium
Subscription
ban
Guild
Member
close
Voice
Connection
connect
create
Channel
create
Channel
Invite
create
Channel
Webhook
create
Group
Channel
create
Guild
create
Guild
Emoji
create
Message
create
Role
crosspost
Message
delete
Channel
delete
Channel
Permission
delete
Guild
delete
Guild
Emoji
delete
Guild
Integration
delete
Invite
delete
Message
delete
Messages
delete
Role
delete
Self
Connection
delete
Self
Premium
Subscription
delete
User
Note
delete
Webhook
disable
SelfMFATOTP
disconnect
editAFK
edit
Channel
edit
Channel
Permission
edit
Channel
Position
edit
Guild
edit
Guild
Emoji
edit
Guild
Integration
edit
Guild
Member
edit
Message
edit
Nickname
edit
Role
edit
Role
Position
edit
Self
edit
Self
Connection
edit
Self
Settings
edit
Status
edit
User
Note
edit
Webhook
emit
enable
SelfMFATOTP
event
Names
execute
Slack
Webhook
execute
Webhook
follow
Channel
get
Bot
Gateway
get
Channel
get
Channel
Invites
get
Channel
Webhooks
getDMChannel
get
Gateway
get
Guild
Audit
Logs
get
Guild
Ban
get
Guild
Bans
get
Guild
Embed
get
Guild
Integrations
get
Guild
Invites
get
Guild
Preview
get
Guild
Vanity
get
Guild
Webhooks
get
Invite
get
Max
Listeners
get
Message
get
Message
Reaction
get
Messages
getOAuth
Application
get
Pins
get
Prune
Count
getRESTChannel
getRESTGuild
getRESTGuild
Channels
getRESTGuild
Emoji
getRESTGuild
Emojis
getRESTGuild
Member
getRESTGuild
Members
getRESTGuild
Roles
getRESTGuilds
getRESTUser
get
Self
get
Self
Billing
get
Self
Connections
get
SelfMFACodes
get
Self
Payments
get
Self
Settings
get
User
Profile
get
Voice
Regions
get
Webhook
join
Voice
Channel
kick
Guild
Member
leave
Guild
leave
Voice
Channel
listener
Count
listeners
off
on
Message
Create
once
pin
Message
prepend
Listener
prepend
Once
Listener
prune
Members
purge
Channel
raw
Listeners
register
Command
register
Command
Alias
register
Guild
Prefix
remove
All
Listeners
remove
Group
Recipient
remove
Guild
Member
Role
remove
Listener
remove
Message
Reaction
remove
Message
Reaction
Emoji
remove
Message
Reactions
remove
Relationship
search
Channel
Messages
search
Guild
Members
search
Guild
Messages
send
Channel
Typing
set
Max
Listeners
sync
Guild
Integration
toJSON
to
String
unban
Guild
Member
unpin
Message
unregister
Command
listener
Count
Generated using
TypeDoc
since v4.0.0