Class Client

Hierarchy

TypedEmitter<ClientEvents, this>
- Client

Index

Constructors

constructor

new Client(params: ClientOptions): Client
Parameters
- params: ClientOptions
Returns Client
Overrides TypedEmitter.constructor
- Defined in lib/structures/Client.ts:48

Properties

cache

cache: {
    forumThreads: TypedCollection<string | number, APIForumTopic, ForumThread, []>;
    guilds: TypedCollection<string | number, APIGuild, Guild, []>;
    members: TypedCollection<string | number, APIGuildMember, Member, [guildID: string]>;
    messages: TypedCollection<string | number, APIChatMessage, Message, [params?: {
        oldMessage?: object;
        originalMessageID?: null | string;
    }]>;
    users: TypedCollection<string | number, APIUser, User, []>;
}

Type declaration

forumThreads: TypedCollection<string | number, APIForumTopic, ForumThread, []>
guilds: TypedCollection<string | number, APIGuild, Guild, []>
members: TypedCollection<string | number, APIGuildMember, Member, [guildID: string]>
messages: TypedCollection<string | number, APIChatMessage, Message, [params?: {
oldMessage?: object;
originalMessageID?: null | string;
}]>
users: TypedCollection<string | number, APIUser, User, []>

calls

calls: call

identifiers

identifiers: {
    BotServerMembershipCreated: string;
    CalendarEventCreated: string;
    CalendarEventDeleted: string;
    CalendarEventRsvpDeleted: string;
    CalendarEventRsvpUpdated: string;
    CalendarEventUpdated: string;
    ChannelMessageReactionCreated: string;
    ChannelMessageReactionDeleted: string;
    ChatMessageCreated: string;
    ChatMessageDeleted: string;
    ChatMessageUpdated: string;
    DocCreated: string;
    DocDeleted: string;
    DocUpdated: string;
    ForumTopicCommentCreated: string;
    ForumTopicCommentDeleted: string;
    ForumTopicCommentUpdated: string;
    ForumTopicCreated: string;
    ForumTopicDeleted: string;
    ForumTopicLocked: string;
    ForumTopicPinned: string;
    ForumTopicReactionCreated: string;
    ForumTopicReactionDeleted: string;
    ForumTopicUnlocked: string;
    ForumTopicUnpinned: string;
    ForumTopicUpdated: string;
    ListItemCompleted: string;
    ListItemCreated: string;
    ListItemDeleted: string;
    ListItemUncompleted: string;
    ListItemUpdated: string;
    ServerChannelCreated: string;
    ServerChannelDeleted: string;
    ServerChannelUpdated: string;
    ServerMemberBanned: string;
    ServerMemberJoined: string;
    ServerMemberRemoved: string;
    ServerMemberUnbanned: string;
    ServerMemberUpdated: string;
    ServerRolesUpdated: string;
    ServerWebhookCreated: string;
    ServerWebhookUpdated: string;
}

Type declaration

BotServerMembershipCreated: string
CalendarEventCreated: string
CalendarEventDeleted: string
CalendarEventRsvpDeleted: string
CalendarEventRsvpUpdated: string
CalendarEventUpdated: string
ChannelMessageReactionCreated: string
ChannelMessageReactionDeleted: string
ChatMessageCreated: string
ChatMessageDeleted: string
ChatMessageUpdated: string
DocCreated: string
DocDeleted: string
DocUpdated: string
ForumTopicCommentCreated: string
ForumTopicCommentDeleted: string
ForumTopicCommentUpdated: string
ForumTopicCreated: string
ForumTopicDeleted: string
ForumTopicLocked: string
ForumTopicPinned: string
ForumTopicReactionCreated: string
ForumTopicReactionDeleted: string
ForumTopicUnlocked: string
ForumTopicUnpinned: string
ForumTopicUpdated: string
ListItemCompleted: string
ListItemCreated: string
ListItemDeleted: string
ListItemUncompleted: string
ListItemUpdated: string
ServerChannelCreated: string
ServerChannelDeleted: string
ServerChannelUpdated: string
ServerMemberBanned: string
ServerMemberJoined: string
ServerMemberRemoved: string
ServerMemberUnbanned: string
ServerMemberUpdated: string
ServerRolesUpdated: string
ServerWebhookCreated: string
ServerWebhookUpdated: string

params

params: {
    REST?: boolean;
    RESTOptions?: RESTOptions;
    token: string;
}

Type declaration

Optional REST?: boolean
Optional RESTOptions?: RESTOptions
token: string

rest

rest: RESTManager

`Optional` user

user?: UserClient

ws

ws: WSManager

Accessors

token

get token(): string
Bot's token.

Returns string
- Defined in lib/structures/Client.ts:68

Methods

addGuildMemberGroup

addGuildMemberGroup(groupID: string, memberID: string): Promise<void>
Add a member to a group
Parameters
- groupID: string
  
  ID of a guild group.
- memberID: string
  
  ID of a member.
Returns Promise<void>
- Defined in lib/structures/Client.ts:547

addListener

addListener<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.addListener
- Defined in lib/types/TypedEmitter.ts:6

awardMember

awardMember(guildID: string, memberID: string, amount: number): Promise<number>
Award a member using the built-in EXP system.
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- amount: number
  
  Amount of experience.
Returns Promise<number>
- Defined in lib/structures/Client.ts:611

awardRole

awardRole(guildID: string, roleID: number, amount: number): Promise<void>
Award every members of a guild having a role using the built-in EXP system.
Parameters
- guildID: string
  
  ID of a guild.
- roleID: number
  
  ID of a role.
- amount: number
  
  Amount of experience.
Returns Promise<void>
- Defined in lib/structures/Client.ts:629

completeListItem

completeListItem(channelID: string, itemID: string): Promise<void>
Mark a list item as completed.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<void>
- Defined in lib/structures/Client.ts:530

connect

connect(): void
Connect to Guilded.

Returns void
- Defined in lib/structures/Client.ts:74

createCalendarEvent

createCalendarEvent(channelID: string, options: {
    color?: number;
    description?: string;
    duration?: number;
    isPrivate?: boolean;
    location?: string;
    name: string;
    rsvpLimit?: number;
    startsAt?: string;
    url?: string;
}): Promise<CalendarEvent>
Create an event into a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- options: {
      color?: number;
      description?: string;
      duration?: number;
      isPrivate?: boolean;
      location?: string;
      name: string;
      rsvpLimit?: number;
      startsAt?: string;
      url?: string;
  }
  
  Event options.
  - Optional color?: number
  - Optional description?: string
  - Optional duration?: number
  - Optional isPrivate?: boolean
  - Optional location?: string
  - name: string
  - Optional rsvpLimit?: number
  - Optional startsAt?: string
  - Optional url?: string
Returns Promise<CalendarEvent>
- Defined in lib/structures/Client.ts:458

createChannel

createChannel(guildID: string, name: string, type: APIChannelCategories, options?: {
    categoryID?: number;
    groupID?: string;
    isPublic?: boolean;
    topic?: string;
}): Promise<Channel>
Create a channel in a specified guild.
Parameters
- guildID: string
  
  ID of a guild.
- name: string
  
  Name of the new channel.
- type: APIChannelCategories
  
  Type of the new channel. (e.g: chat)
- Optional options: {
      categoryID?: number;
      groupID?: string;
      isPublic?: boolean;
      topic?: string;
  }
  
  New channel's additional options.
  - Optional categoryID?: number
  - Optional groupID?: string
  - Optional isPublic?: boolean
  - Optional topic?: string
Returns Promise<Channel>
- Defined in lib/structures/Client.ts:276

createDoc

createDoc(channelID: string, options: {
content: string;
title: string;
}): Promise<Doc>
Create a doc in a "Docs" channel.
Parameters
- channelID: string
  
  ID pf a "Docs" channel.
- options: {
  content: string;
  title: string;
  }
  
  Doc's options.
  - content: string
  - title: string
Returns Promise<Doc>
- Defined in lib/structures/Client.ts:432

createListItem

createListItem(channelID: string, content: string, note?: {
content: string;
}): Promise<ListItem>
Create a new item in a list channel.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- content: string
  
  String content of the new item.
- Optional note: {
  content: string;
  }
  
  Add a note to the new item.
  - content: string
    
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/structures/Client.ts:504

createMessage

createMessage(channelID: string, options: APIMessageOptions): Promise<Message>
Send a message in a specified channel.
Parameters
- channelID: string
  
  ID of the channel.
- options: APIMessageOptions
  
  Message options
Returns Promise<Message>
- Defined in lib/structures/Client.ts:284

createMessageReaction

createMessageReaction(channelID: string, messageID: string, reaction: number): Promise<void>
Add a reaction to a specified message.
Parameters
- channelID: string
  
  ID of a "CHAT" channel.
- messageID: string
  
  ID of the channel message.
- reaction: number
  
  ID of the reaction.
Returns Promise<void>
- Defined in lib/structures/Client.ts:310

createTopic

createTopic(channelID: string, options: {
content: string;
title: string;
}): Promise<ForumThread>
Create a topic in a specified forum channel.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- options: {
  content: string;
  title: string;
  }
  
  Topic's options including title & content.
  - content: string
  - title: string
Returns Promise<ForumThread>
- Defined in lib/structures/Client.ts:328

createTopicComment

createTopicComment(channelID: string, topicID: number, options: {
content: string;
}): Promise<ForumThreadComment>
Add a comment to a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
- options: {
  content: string;
  }
  
  Comment's options.
  - content: string
Returns Promise<ForumThreadComment>
- Defined in lib/structures/Client.ts:404

createTopicReaction

createTopicReaction(channelID: string, topicID: number, emoteID: number): Promise<void>
Add a reaction to a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
- emoteID: number
  
  ID of the emotoe you'd like to add.
Returns Promise<void>
- Defined in lib/structures/Client.ts:386

createWebhook

createWebhook(guildID: string, channelID: string, name: string): Promise<Webhook>
Create a webhook
Parameters
- guildID: string
  
  ID of a guild.
- channelID: string
  
  ID of a channel.
- name: string
  
  Name of the new webhook.
Returns Promise<Webhook>
- Defined in lib/structures/Client.ts:583

deleteCalendarEvent

deleteCalendarEvent(channelID: string, eventID: number): Promise<void>
Delete an event from a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
Returns Promise<void>
- Defined in lib/structures/Client.ts:475

deleteCalendarRsvp

deleteCalendarRsvp(channelID: string, eventID: number, memberID: string): Promise<void>
Delete a RSVP from a calendar event.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
- memberID: string
  
  ID of a member.
Returns Promise<void>
- Defined in lib/structures/Client.ts:494

deleteDoc

deleteDoc(channelID: string, docID: number): Promise<void>
Delete a doc from a "Docs" channel.
Parameters
- channelID: string
  
  ID of a "Docs" channel.
- docID: number
  
  ID of a doc.
Returns Promise<void>
- Defined in lib/structures/Client.ts:449

deleteListItem

deleteListItem(channelID: string, itemID: string): Promise<void>
Delete an item from a list channel.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<void>
- Defined in lib/structures/Client.ts:522

deleteMessage

deleteMessage(channelID: string, messageID: string): Promise<void>
Delete a specific message.
Parameters
- channelID: string
  
  ID of the channel containing the message.
- messageID: string
  
  ID of the message you'd like to delete.
Returns Promise<void>
- Defined in lib/structures/Client.ts:301

deleteTopic

deleteTopic(channelID: string, topicID: number): Promise<void>
Delete a topic from a specific forum channel
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
Returns Promise<void>
- Defined in lib/structures/Client.ts:345

deleteTopicComment

deleteTopicComment(channelID: string, topicID: number, commentID: number): Promise<void>
Delete a forum topic comment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
- commentID: number
  
  ID of a topic comment.
Returns Promise<void>
- Defined in lib/structures/Client.ts:423

deleteTopicReaction

deleteTopicReaction(channelID: string, topicID: number, emoteID: number): Promise<void>
Remove a reaction from a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
- emoteID: number
  
  ID of the emotoe you'd like to remove.
Returns Promise<void>
- Defined in lib/structures/Client.ts:395

deleteWebhook

deleteWebhook(guildID: string, webhookID: string): Promise<void>
Delete a webhook
Parameters
- guildID: string
  
  ID of a guild.
- webhookID: string
  
  ID of an existent webhook.
Returns Promise<void>
- Defined in lib/structures/Client.ts:600

disconnect

disconnect(crashOnDisconnect?: boolean): void
Disconnect from Guilded.
Parameters
- Optional crashOnDisconnect: boolean
  
  If set, throws an error to stop the process.
Returns void
- Defined in lib/structures/Client.ts:90

editCalendarEvent

editCalendarEvent(channelID: string, eventID: number, options: {
    color?: number;
    description?: string;
    duration?: number;
    isPrivate?: boolean;
    location?: string;
    name?: string;
    rsvpLimit?: number;
    startsAt?: string;
    url?: string;
}): Promise<CalendarEvent>
Edit an event from a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
- options: {
      color?: number;
      description?: string;
      duration?: number;
      isPrivate?: boolean;
      location?: string;
      name?: string;
      rsvpLimit?: number;
      startsAt?: string;
      url?: string;
  }
  
  Edit options.
  - Optional color?: number
  - Optional description?: string
  - Optional duration?: number
  - Optional isPrivate?: boolean
  - Optional location?: string
  - Optional name?: string
  - Optional rsvpLimit?: number
  - Optional startsAt?: string
  - Optional url?: string
Returns Promise<CalendarEvent>
- Defined in lib/structures/Client.ts:467

editCalendarRsvp

editCalendarRsvp(channelID: string, eventID: number, memberID: string, options: PUTCalendarEventRSVPBody): Promise<CalendarEventRSVP>
Add/Edit a RSVP in a calendar event.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
- memberID: string
  
  ID of a member.
- options: PUTCalendarEventRSVPBody
  
  Edit options.
Returns Promise<CalendarEventRSVP>
- Defined in lib/structures/Client.ts:485

editDoc

editDoc(channelID: string, docID: number, options: {
content: string;
title: string;
}): Promise<Doc>
Edit a doc from a "Docs" channel.
Parameters
- channelID: string
  
  ID of a "Docs" channel.
- docID: number
  
  ID of a doc.
- options: {
  content: string;
  title: string;
  }
  
  Edit options.
  - content: string
  - title: string
Returns Promise<Doc>
- Defined in lib/structures/Client.ts:441

editListItem

editListItem(channelID: string, itemID: string, content: string, note?: {
content: string;
}): Promise<ListItem>
Edit an item from a list channel.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
- content: string
  
  New item's content.
- Optional note: {
  content: string;
  }
  
  Add a note to the item.
  - content: string
    
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/structures/Client.ts:514

editMessage

editMessage(channelID: string, messageID: string, newMessage: object): Promise<Message>
Edit a specific message coming from a specified channel.
Parameters
- channelID: string
  
  The ID of the channel.
- messageID: string
  
  The ID of the message you'd like to edit.
- newMessage: object
  
  object containing new message's options.
Returns Promise<Message>
- Defined in lib/structures/Client.ts:293

editTopic

editTopic(channelID: string, topicID: number, options: {
content?: string;
title?: string;
}): Promise<ForumThread>
Edit a topic from a specified forum channel.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
- options: {
  content?: string;
  title?: string;
  }
  
  Edit options.
  - Optional content?: string
  - Optional title?: string
Returns Promise<ForumThread>
- Defined in lib/structures/Client.ts:337

editTopicComment

editTopicComment(channelID: string, topicID: number, commentID: number, options?: {
content?: string;
}): Promise<ForumThreadComment>
Edit a forum topic's comment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
- commentID: number
  
  ID of a topic comment.
- Optional options: {
  content?: string;
  }
  
  Edit options.
  - Optional content?: string
Returns Promise<ForumThreadComment>
- Defined in lib/structures/Client.ts:414

editWebhook

editWebhook(guildID: string, webhookID: string, options: PUTGuildWebhookBody): Promise<Webhook>
Update a webhook
Parameters
- guildID: string
  
  ID of a guild.
- webhookID: string
  
  ID of an existent webhook.
- options: PUTGuildWebhookBody
  
  Edit options.
Returns Promise<Webhook>
- Defined in lib/structures/Client.ts:592

emit

emit<K>(eventName: K, ...args: ClientEvents[K]): boolean
Type Parameters
- K extends keyof ClientEvents
Parameters
- eventName: K
- Rest ...args: ClientEvents[K]
Returns boolean
Inherited from TypedEmitter.emit
- Defined in lib/types/TypedEmitter.ts:7
emit<K>(eventName: K, ...args: ClientEvents[K]): boolean
Type Parameters
- K extends keyof ClientEvents
Parameters
- eventName: K
- Rest ...args: ClientEvents[K]
Returns boolean
Inherited from TypedEmitter.emit
- Defined in lib/types/TypedEmitter.ts:22

eventNames

eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Since

v6.0.0

Returns (string | symbol)[]

getCalendarEvent

getCalendarEvent(channelID: string, eventID: number): Promise<CalendarEvent>
This method is used to get a specific calendar event.

Note: this method requires a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a Calendar channel.
- eventID: number
  
  ID of a Calendar event.
Returns Promise<CalendarEvent>
- Defined in lib/structures/Client.ts:212

getCalendarEvents

getCalendarEvents(channelID: string, filter?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<CalendarEvent[]>
This method is used to get a list of CalendarEvent
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- Optional filter: {
      after?: string;
      before?: string;
      limit?: number;
  }
  
  Object to filter the output.
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<CalendarEvent[]>
- Defined in lib/structures/Client.ts:202

getCalendarRsvp

getCalendarRsvp(channelID: string, eventID: number, memberID: string): Promise<CalendarEventRSVP>
This method is used to get a specific CalendarEventRSVP.

Note: this method requires a Calendar channel.
Parameters
- channelID: string
  
  ID of a Calendar channel
- eventID: number
  
  ID of a Calendar Event
- memberID: string
  
  ID of a Guild Member
Returns Promise<CalendarEventRSVP>
- Defined in lib/structures/Client.ts:223

getCalendarRsvps

getCalendarRsvps(channelID: string, eventID: number): Promise<CalendarEventRSVP[]>
This method is used to get a list of CalendarEventRSVP.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
Returns Promise<CalendarEventRSVP[]>
- Defined in lib/structures/Client.ts:231

getChannel

getChannel(channelID: string): Promise<Channel>
This method is used to get a specific guild channel.

Note: You do not need a guildID to get a channel, only the channelID is needed.
Parameters
- channelID: string
  
  The ID of the channel you'd like to get.
Returns Promise<Channel>
- Defined in lib/structures/Client.ts:103

getChannelMessage

getChannelMessage(channelID: string, messageID: string): Promise<Message>
This method is used to get a specific channel message
Parameters
- channelID: string
  
  ID of the channel containing the message.
- messageID: string
  
  ID of the message you'd like to get.
Returns Promise<Message>
- Defined in lib/structures/Client.ts:130

getChannelMessages

getChannelMessages(channelID: string, filter?: {
    after?: string;
    before?: string;
    includePrivate?: boolean;
    limit?: number;
}): Promise<Message[]>
This method is used to get a list of Message
Parameters
- channelID: string
  
  ID of a "Chat" channel.
- Optional filter: {
      after?: string;
      before?: string;
      includePrivate?: boolean;
      limit?: number;
  }
  
  Object to filter the output.
  - Optional after?: string
  - Optional before?: string
  - Optional includePrivate?: boolean
  - Optional limit?: number
Returns Promise<Message[]>
- Defined in lib/structures/Client.ts:138

getDoc

getDoc(channelID: string, docID: number): Promise<Doc>
This method is used to get a channel doc.

Note: This method requires a "Docs" channel.
Parameters
- channelID: string
  
  ID of the Docs channel.
- docID: number
  
  ID of the channel doc.
Returns Promise<Doc>
- Defined in lib/structures/Client.ts:157

getDocs

getDocs(channelID: string, filter?: {
before?: string;
limit?: number;
}): Promise<Doc[]>
This method is used to get a list of "Channel" Doc.
Parameters
- channelID: string
  
  ID of a "Docs" channel.
- Optional filter: {
  before?: string;
  limit?: number;
  }
  
  Object to filter the output.
  - Optional before?: string
  - Optional limit?: number
Returns Promise<Doc[]>
- Defined in lib/structures/Client.ts:147

getForumTopic

getForumTopic(channelID: string, topicID: number): Promise<ForumThread>
This method is used to get a specific forum topic.

Note: This method requires a "Forum" channel.
Parameters
- channelID: string
  
  ID of a speific Forum channel.
- topicID: number
  
  ID of the specific Forum Topic.
Returns Promise<ForumThread>
- Defined in lib/structures/Client.ts:176

getGuild

getGuild(guildID: string): Promise<Guild>
This method is used to get a specific Guild.

Note: Guild = Server
Parameters
- guildID: string
  
  The ID of the guild you'd like to get.
Returns Promise<Guild>
- Defined in lib/structures/Client.ts:122

getListItem

getListItem(channelID: string, itemID: string): Promise<ListItem>
This method is used to get a specific list item.
Parameters
- channelID: string
  
  ID of a "List" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<ListItem>
- Defined in lib/structures/Client.ts:240

getListItems

getListItems(channelID: string): Promise<ListItem[]>
This method is used to get a list of ListItem.
Parameters
- channelID: string
  
  ID of a "List" channel.
Returns Promise<ListItem[]>
- Defined in lib/structures/Client.ts:247

getMaxListeners

getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Since
v1.0.0

Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:526

getMember

getMember(guildID: string, memberID: string): Promise<Member>
This method is used to get a specific guild member.
Parameters
- guildID: string
  
  The ID of the Guild.
- memberID: string
  
  The ID of the Guild Member you'd like to get.
Returns Promise<Member>
- Defined in lib/structures/Client.ts:111

getRESTForumTopics

getRESTForumTopics(channelID: string, filter?: {
before?: string;
limit?: number;
}): Promise<ForumThread[]>
This method is used to get a list of ForumTopic.
Parameters
- channelID: string
  
  ID of a "Forum" channel.
- Optional filter: {
  before?: string;
  limit?: number;
  }
  
  Object to filter the output.
  - Optional before?: string
  - Optional limit?: number
Returns Promise<ForumThread[]>
- Defined in lib/structures/Client.ts:166

getTopicComment

getTopicComment(channelID: string, topicID: number, commentID: number): Promise<ForumThreadComment>
This method is used to get a specific topic comment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a Forum topic.
- commentID: number
  
  ID of a Forum topic comment.
Returns Promise<ForumThreadComment>
- Defined in lib/structures/Client.ts:193

getTopicComments

getTopicComments(channelID: string, topicID: number): Promise<ForumThreadComment[]>
This method is used to get a list of ForumTopicComment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a Forum Topic.
Returns Promise<ForumThreadComment[]>
- Defined in lib/structures/Client.ts:184

getWebhook

getWebhook(guildID: string, webhookID: string): Promise<Webhook>
This method is used to get a specific webhook.
Parameters
- guildID: string
  
  ID of a guild.
- webhookID: string
  
  ID of a webhook.
Returns Promise<Webhook>
- Defined in lib/structures/Client.ts:255

getWebhooks

getWebhooks(guildID: string, channelID: string): Promise<Webhook[]>
This method is used to get a list of Webhook.
Parameters
- guildID: string
  
  ID of a guild.
- channelID: string
  
  ID of a channel.
Returns Promise<Webhook[]>
- Defined in lib/structures/Client.ts:263

listenerCount

listenerCount(eventName: keyof ClientEvents): number
Parameters
- eventName: keyof ClientEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in lib/types/TypedEmitter.ts:8

listeners

listeners(eventName: keyof ClientEvents): Function[]
Parameters
- eventName: keyof ClientEvents
Returns Function[]
Inherited from TypedEmitter.listeners
- Defined in lib/types/TypedEmitter.ts:9

lockTopic

lockTopic(channelID: string, topicID: number): Promise<void>
Lock a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
Returns Promise<void>
- Defined in lib/structures/Client.ts:369

memberAddRole

memberAddRole(guildID: string, memberID: string, roleID: number): Promise<void>
Add a role to a member
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- roleID: number
  
  ID of a role.
Returns Promise<void>
- Defined in lib/structures/Client.ts:565

memberRemoveRole

memberRemoveRole(guildID: string, memberID: string, roleID: number): Promise<void>
Remove a role from a member
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- roleID: number
  
  ID of a role.
Returns Promise<void>
- Defined in lib/structures/Client.ts:574

off

off<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.off
- Defined in lib/types/TypedEmitter.ts:10

on

on<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.on
- Defined in lib/types/TypedEmitter.ts:11

once

once<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.once
- Defined in lib/types/TypedEmitter.ts:12

pinTopic

pinTopic(channelID: string, topicID: number): Promise<void>
Pin a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
Returns Promise<void>
- Defined in lib/structures/Client.ts:353

prependListener

prependListener<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.prependListener
- Defined in lib/types/TypedEmitter.ts:13

prependOnceListener

prependOnceListener<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.prependOnceListener
- Defined in lib/types/TypedEmitter.ts:14

rawListeners

rawListeners(eventName: keyof ClientEvents): Function[]
Parameters
- eventName: keyof ClientEvents
Returns Function[]
Inherited from TypedEmitter.rawListeners
- Defined in lib/types/TypedEmitter.ts:15

removeAllListeners

removeAllListeners(event?: keyof ClientEvents): Client
Parameters
- Optional event: keyof ClientEvents
Returns Client
Inherited from TypedEmitter.removeAllListeners
- Defined in lib/types/TypedEmitter.ts:16

removeGuildMemberGroup

removeGuildMemberGroup(groupID: string, memberID: string): Promise<void>
Remove a member from a group
Parameters
- groupID: string
  
  ID of a guild group.
- memberID: string
  
  ID of a member.
Returns Promise<void>
- Defined in lib/structures/Client.ts:555

removeListener

removeListener<K>(event: K, listener: ((...args: ClientEvents[K]) => void)): Client
Type Parameters
- K extends keyof ClientEvents
Parameters
- event: K
- listener: ((...args: ClientEvents[K]) => void)
  - - (...args: ClientEvents[K]): void
    - Parameters
      
      Rest ...args: ClientEvents[K]
      
      Returns void
Returns Client
Inherited from TypedEmitter.removeListener
- Defined in lib/types/TypedEmitter.ts:17

removeMessageReaction

removeMessageReaction(channelID: string, messageID: string, reaction: number): Promise<void>
Remove a reaction from a message.
Parameters
- channelID: string
  
  ID of a "CHAT" channel.
- messageID: string
  
  ID of the channel message.
- reaction: number
  
  ID of the reaction.
Returns Promise<void>
- Defined in lib/structures/Client.ts:319

setMaxListeners

setMaxListeners(n: number): Client
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Since
v0.3.5
Parameters
- n: number
Returns Client
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/@types/node/ts4.8/events.d.ts:520

setMemberXP

setMemberXP(guildID: string, memberID: string, amount: number): Promise<number>
Set a member's xp using the built-in EXP system.
Parameters
- guildID: string
  
  ID of a guild.
- memberID: string
  
  ID of a member.
- amount: number
  
  Total amount of experience.
Returns Promise<number>
- Defined in lib/structures/Client.ts:620

uncompleteListItem

uncompleteListItem(channelID: string, itemID: string): Promise<void>
Mark a list item as uncompleted.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<void>
- Defined in lib/structures/Client.ts:538

unlockTopic

unlockTopic(channelID: string, topicID: number): Promise<void>
Unlock a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
Returns Promise<void>
- Defined in lib/structures/Client.ts:377

unpinTopic

unpinTopic(channelID: string, topicID: number): Promise<void>
Unpin a forum topic.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- topicID: number
  
  ID of a topic.
Returns Promise<void>
- Defined in lib/structures/Client.ts:361

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: ClientOptions

Returns Client

Properties

cache

Type declaration

forumThreads: TypedCollection<string | number, APIForumTopic, ForumThread, []>

guilds: TypedCollection<string | number, APIGuild, Guild, []>

members: TypedCollection<string | number, APIGuildMember, Member, [guildID: string]>

messages: TypedCollection<string | number, APIChatMessage, Message, [params?: { oldMessage?: object; originalMessageID?: null | string; }]>

users: TypedCollection<string | number, APIUser, User, []>

calls

identifiers

Type declaration

BotServerMembershipCreated: string

CalendarEventCreated: string

CalendarEventDeleted: string

CalendarEventRsvpDeleted: string

CalendarEventRsvpUpdated: string

CalendarEventUpdated: string

ChannelMessageReactionCreated: string

ChannelMessageReactionDeleted: string

ChatMessageCreated: string

ChatMessageDeleted: string

ChatMessageUpdated: string

DocCreated: string

DocDeleted: string

DocUpdated: string

ForumTopicCommentCreated: string

ForumTopicCommentDeleted: string

ForumTopicCommentUpdated: string

ForumTopicCreated: string

ForumTopicDeleted: string

ForumTopicLocked: string

ForumTopicPinned: string

ForumTopicReactionCreated: string

ForumTopicReactionDeleted: string

ForumTopicUnlocked: string

ForumTopicUnpinned: string

ForumTopicUpdated: string

ListItemCompleted: string

ListItemCreated: string

ListItemDeleted: string

ListItemUncompleted: string

ListItemUpdated: string

ServerChannelCreated: string

ServerChannelDeleted: string

ServerChannelUpdated: string

ServerMemberBanned: string

ServerMemberJoined: string

ServerMemberRemoved: string

ServerMemberUnbanned: string

ServerMemberUpdated: string

ServerRolesUpdated: string

ServerWebhookCreated: string

ServerWebhookUpdated: string

params

Type declaration

Optional REST?: boolean

Optional RESTOptions?: RESTOptions

token: string

rest

Optional user

ws

Accessors

token

Returns string

Methods

addGuildMemberGroup

Parameters

groupID: string

messages: TypedCollection<string | number, APIChatMessage, Message, [params?: {
oldMessage?: object;
originalMessageID?: null | string;
}]>

`Optional` REST?: boolean

`Optional` RESTOptions?: RESTOptions

`Optional` user

`Rest` ...args: ClientEvents[K]

options: {
color?: number;
description?: string;
duration?: number;
isPrivate?: boolean;
location?: string;
name: string;
rsvpLimit?: number;
startsAt?: string;
url?: string;
}

`Optional` color?: number

`Optional` description?: string

`Optional` duration?: number

`Optional` isPrivate?: boolean

`Optional` location?: string

`Optional` rsvpLimit?: number

`Optional` startsAt?: string

`Optional` url?: string

`Optional` options: {
categoryID?: number;
groupID?: string;
isPublic?: boolean;
topic?: string;
}

`Optional` categoryID?: number

`Optional` groupID?: string

`Optional` isPublic?: boolean

`Optional` topic?: string

options: {
content: string;
title: string;
}

`Optional` note: {
content: string;
}