Methods
addPin
- addPin(channelId: string, messageId: string): Promise<never>
-
Parameters
-
channelId: string
-
messageId: string
Returns Promise<never>
createInvite
- createInvite(channelId: string, invite?: RESTPostAPIChannelInviteJSONBody): Promise<APIExtendedInvite>
-
Parameters
-
channelId: string
-
invite: RESTPostAPIChannelInviteJSONBody = {}
Returns Promise<APIExtendedInvite>
delete
- delete(channelId: string): Promise<APIChannel>
-
Parameters
Returns Promise<APIChannel>
deletePermission
- deletePermission(channelId: string, overwriteId: string): Promise<never>
-
Parameters
-
channelId: string
-
overwriteId: string
Returns Promise<never>
deletePin
- deletePin(channelId: string, messageId: string): Promise<never>
-
Parameters
-
channelId: string
-
messageId: string
Returns Promise<never>
edit
- edit(channelId: string, patch: RESTPatchAPIChannelJSONBody): Promise<APIChannel>
-
Parameters
-
channelId: string
-
patch: RESTPatchAPIChannelJSONBody
Returns Promise<APIChannel>
get
- get(channelId: string): Promise<APIChannel>
-
Parameters
Returns Promise<APIChannel>
getInvites
- getInvites(channelId: string): Promise<RESTGetAPIChannelInvitesResult>
-
Parameters
Returns Promise<RESTGetAPIChannelInvitesResult>
getMessages
- getMessages(channelId: string, query: RESTGetAPIChannelMessagesQuery): Promise<RESTGetAPIChannelMessagesResult>
-
Parameters
-
channelId: string
-
query: RESTGetAPIChannelMessagesQuery
Returns Promise<RESTGetAPIChannelMessagesResult>
getPins
- getPins(channelId: string): Promise<RESTGetAPIChannelPinsResult>
-
Parameters
Returns Promise<RESTGetAPIChannelPinsResult>
setMemberPermission
- setMemberPermission(channelId: string, memberId: string, allow?: string, deny?: string): Promise<never>
-
Parameters
-
channelId: string
-
memberId: string
-
Optional allow: string
-
Optional deny: string
Returns Promise<never>
setRolePermission
- setRolePermission(channelId: string, roleId: string, allow?: string, deny?: string): Promise<never>
-
Parameters
-
channelId: string
-
roleId: string
-
Optional allow: string
-
Optional deny: string
Returns Promise<never>
typing
- typing(channelId: string): Promise<never>
-
Parameters
Returns Promise<never>
Channels resource