🤖Client

The Guilded Bot's client, where everything's happen and where the Guilded bot interacts with guilds/servers.

Properties

Constructor

new Client(params)

Methods

Client have standard event emitter types, they're not listed there.

connect()

Connects your bot to the Guilded API.

getRESTChannel(channelID)

Get a specific channel's information.

Returns: Promise<Channel>

getRESTMember(guildID, memberID)

Get a specific guild's/server's member.

Returns: Promise<Member>

getRESTGuild(guildID)

Get a specific guild/server.

Returns: Promise<Guild>

getRESTChannelMessages(channelID, filter?)

Get a list channel Message component.

Returns: Promise<Array<Message>>

getRESTChannelDocs(channelID, filter?)

Get a list of channel Doc component.

Returns: Promise<Array<Doc>>

getRESTChannelDoc(channelID, docID)

Get a specific channel doc.

Returns: Promise<Doc>

getRESTForumTopics(channelID, filter?)

Get a list of ForumTopic component.

Returns: Promise<Array<ForumTopic>>

getRESTForumTopic(channelID, topicID)

Get a specific ForumTopic component

Returns: Promise<ForumTopic>

getRESTCalendarEvents(channelID, filter?)

Get a list of CalendarEvent component

Returns: Promise<Array<CalendarEvent>>

getRESTCalendarEvent(channelID, eventID)

Get a specific calendar event component

Returns: Promise<CalendarEvent>

getRESTCalendarRsvps(channelID, eventID)

Get a list of calendar event rsvp

Returns: Promise<Array<CalendarEventRSVP>>

getRESTCalendarRsvp(channelID, eventID, memberID)

Get a specific calendar event rsvp

Returns: Promise<CalendarEventRSVP>

getRESTListItem(channelID, itemID)

Get a specific item from a list channel.

Returns: Promise<ListItem>

getRESTListItems(channelID)

Get a list of ListItem from a list channel.

Returns: Promise<Array<ListItem>>

getRESTGuildWebhook(guildID, webhookID)

Get a guild webhook.

Returns: Promise<Webhook>

getRESTChannelWebhooks(guildID, channelID)

Get a list of webhook selected from a specific channel.

Returns: Promise<Array<Webhook>>

getChannelMessages(channelID, filter?)

Get a list of channel messages, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

getChannelDocs(channelID, filter?)

Get a list of channel docs, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

getForumTopics(channelID, filter?)

Get a list of forum topic, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

getCalendarEvents(channelID, filter?)

Get a list of calendar event, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

getCalendarRsvps(channelID, eventID)

Get a list of calendar event rsvp, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

getListItems(channelID)

List of item of the selected list channel, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

getMemberRoles(guildID, memberID)

Gives you a list of every roles the member has.

getMemberRoles is the only proposed method to get member's roles, it is because there is nothing to treat, it's just an array of 'roles' which are numbers/int.

Returns: Promise<Array<Number>>

getChannelWebhooks(guildID, channelID)

Returns you a list of channel webhooks, only basic data included.

Returns: Promise<Array<Object>>

Non-REST Methods only returns an object/array, methods and cached information aren't provided.

Be aware that the returned object/array is having Guilded API types and not ours.

Non-REST Methods can provide better response time than the REST ones when it treats multiple object of information.

createChannel(location, name, type, options)

Create a channel in a guild, can also be placed in a group or category.

Returns: Promise<Channel>

createMessage(channelID, options)

Create a message in a specific channel.

Returns: Promise<Message>

editMessage(channelID, messageID, newMessage)

Update a specific message.

Returns: Promise<Message>

deleteMessage(channelID, messageID)

Delete a specific message.

Returns: Promise<void>

addMessageReaction(channelID, messageID, reaction)

Add a reaction to a channel message

Returns: Promise<void>

removeMessageReaction(channelID, messageID, reaction)

Remove a specific reaction from a channel message.

Returns: Promise<void>

createTopic(channelID, options)

Create a topic in a forum.

Returns: Promise<ForumTopic>

editTopic(channelID, topicID)

Edit a specific forum topic

Returns: Promise<ForumTopic>

deleteTopic(channelID, topicID)

Delete a specific forum topic

Returns: Promise<void>

pinTopic(channelID, topicID)

Pin a specific forum topic.

Returns: Promise<void>

unpinTopic(channelID, topicID)

Unpin a specific forum topic.

Returns: Promise<void>

createDoc(channelID, options)

Create a doc in a docs channel.

Returns: Promise<Doc>

editDoc(channelID, docID, options)

Edit a specific doc.

Returns: Promise<Doc>

deleteDoc(channelID)

Delete a specific channel doc.

Returns: Promise<void>

createCalendarEvent(channelID, options)

Create a calendar event.

Returns: Promise<CalendarEvent>

editCalendarEvent(channelID, eventID, options)

Edit a specific calendar event.

Returns: Promise<CalendarEvent>

deleteCalendarEvent(channelID, eventID)

Delete a specific calendar event.

Returns: Promise<void>

editCalendarRsvp(channelID, eventID, memberID)

Add/edit a specific calendar event RSVP.

Returns: Promise<CalendarEventRSVP>

deleteCalendarRsvp(channelID, eventID, memberID)

Delete a specific calendar event RSVP.

Returns: Promise<void>

createListItem(channelID, content, note?)

Create an item within a list channel.

Returns: Promise<ListItem>

editListItem(channelID, itemID, content, note?)

Edit a list item.

Returns: Promise<ListItem>

completeListItem(channelID, itemID)

Complete (checkmark will show up) a specific item from a list channel.

Returns: Promise<void>

uncompleteListItem(channelID, itemID)

Uncomplete (checkmark will disappear) a specific item from a list channel.

Returns: Promise<void>

addGuildMemberGroup(groupID, memberID)

Add a Guild Member to a Guild group.

Returns: Promise<void>

removeGuildMemberGroup(groupID, memberID)

Remove a Guild Member from a Guild group.

Returns: Promise<void>

addGuildMemberRole(guildID, memberID, roleID)

Add a role to a guild member.

Returns: Promise<void>

removeGuildMemberRole(guildID, memberID, roleID)

Remove a role from a guild member.

Returns: Promise<void>

createGuildWebhook(guildID, channelID, name)

Create a new guild channel webhook.

Returns: Promise<Webhook>

editGuildWebhook(guildID, webhookID, options)

Edit a guild webhook.

Returns: Promise<Webhook>

deleteGuildWebhook(guildID, webhookID)

Delete a guild webhok.

Returns: Promise<void>

Last updated