Properties
Methods
.rest
.addMemberToGroup(groupId:string
,
userId:string
)
Add member to group
.addReactionEmote(channelId:string
,
contentId:string
,
emoteId:number
)
Add a reaction emote
.assignRoleToMember(serverId:string
,
userId:string
,
roleId:number
)
Assign role to member
.awardMemberXP(serverId:string
,
userId:string
,
amount:number
)
Award XP to a member
.awardRoleXP(serverId:string
,
roleId:string
,
amount:number
)
Award XP to a role
.banMember(serverId:string
,
userId:string
)
Ban a member from a server
.completeListItem(channelId:string
,
itemId:string
)
.createCalendarEvent(channelId:string
,
options:RESTPostCalendarEventBody)
Create a calendar event.
.createChannelMessage(channelId:string
,
content:RESTPostChannelMessagesBody)
Send a message to a channel
.createForumTopic(channelId:string
,
options:RESTPostForumTopicBody)
Create a topic in a forum
.createListItem(channelId:string
,
options:RESTPostListItemBody)
Create a list item.
.createWebhook(serverId:string
,
options:RESTPostServerWebhooksBody)
Create a webhook
.deleteCalendarEvent(channelId:string
,
calendarEventId:number
)
Delete a calendar event.
.deleteCalendarEventRvsp(channelId:string
,
calendarEventId:number
,
userId:string
)
Delete an rsvp user from a calendar event
.deleteChannel(channelId:string
)
Delete a channel
.deleteChannelMessage(channelId:string
,
messageId:string
)
Delete a channel message.
.deleteDoc(channelId:string
,
docId:number
)
Delete a doc from a channel.
.deleteForumTopic(channelId:string
,
forumThreadId:string
)
Delete a topic in a forum
.deleteListItem(channelId:string
,
itemId:string
)
Delete list item
.deleteMemberNickname(serverId:string
,
userId:string
)
Delete a member's nickname
.deleteReactionEmote(channelId:string
,
contentId:string
,
emoteId:number
)
Delete a reaction emote
.deleteWebhook(serverId:string
,
webhookId:string
)
Delete a webhook
.getCalendarEvent(channelId:string
,
calendarEventId:number
)
Get a single calendar event.
.getCalendarEventRsvp(channelId:string
,
calendarEventId:number
,
userId:string
)
Get a single rsvp from a calendar event
.getCalendarEventRsvps(channelId:string
,
calendarEventId:number
)
Get rsvps from a calendar event
.getCalendarEvents(channelId:string
,
options:RESTGetCalendarEventsBody)
Get all calendar events in a specific channel.
.getChannelMessage(channelId:string
,
messageId:string
)
Get details for a specific chat message from a chat channel.
.getChannelMessages(channelId:string
,
options:RESTGetChannelMessagesQuery)
Get a list of the latest 50 messages from a channel.
.getForumTopic(channelId:string
,
forumThreadId:string
)
Get a topic in a forum
.getForumTopics(channelId:string
,
options:RESTGetForumTopicsQuery)
Get all topics in a forum
.getMember(serverId:string
,
userId:string
)
.getMemberBan(serverId:string
,
userId:string
)
Retrieve a ban from a server
.getMemberRoles(serverId:string
,
userId:string
)
Get a list of the roles assigned to a member using the id of the member.
.getMemberSocialLinks(serverId:string
,
userId:string
,
type:UserSocialLink)
Retrieves a member's public social links
.getMembers(serverId:string
)
.getWebhooks(serverId:string
,
channelId:string
)
Get a server's webhooks
.kickMember(serverId:string
,
userId:string
)
.lockForumTopic(channelId:string
,
forumThreadId:string
)
Lock a topic in a forum
.pinForumTopic(channelId:string
,
forumThreadId:string
)
Pin a topic in a forum
.removeMemberFromGroup(groupId:string
,
userId:string
)
Remove member from group
.removeRoleFromMember(serverId:string
,
userId:string
,
roleId:number
)
Remove role to member
.unbanMember(serverId:string
,
userId:string
)
Unban a member from a server
.uncompleteListItem(channelId:string
,
itemId:string
)
.unlockForumTopic(channelId:string
,
forumThreadId:string
)
Unlock a topic in a forum
.unpinForumTopic(channelId:string
,
forumThreadId:string
)
Pin a topic in a forum
.updateCalendarEvent(channelId:string
,
calendarEventId:number
,
options:RESTPatchCalendarEventBody)
Update an existing calendar event.
.updateCalendarEventRvsp(channelId:string
,
calendarEventId:number
,
userId:string
,
options:RESTPatchCalendarEventRsvpBody)
Update an rsvp user from a calendar event
.updateChannel(channelId:string
,
data:RESTPatchChannelBody)
Update a channel
.updateChannelMessage(channelId:string
,
messageId:string
,
options:RESTPutChannelMessageBody)
Update a channel message.
.updateDoc(channelId:string
,
docId:number
,
options:RESTPutDocBody)
Update a doc
.updateForumTopic(channelId:string
,
forumThreadId:string
,
options:RESTPatchForumTopicBody)
Update a topic in a forum
.updateListItem(channelId:string
,
itemId:string
,
options:RESTPutListItemBody)
Update list item
.updateMemberNickname(serverId:string
,
userId:string
,
nickname:string
)
Update a member's nickname.
.updateWebhook(serverId:string
,
webhookId:string
,
options:RESTPutServerWebhookBody)
Update a webhook