Channel
HTTP Rest API implementation for the following Resource:
Summary
Functions
Channel.getChannelAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetChannelResponse>Channel.modifyChannelAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyChannelRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyChannelResponse>Channel.deleteOrCloseChannelAsync(instance: request.Request, channelId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteCloseChannelResponse>Channel.editChannelPermissionsAsync(instance: request.Request, channelId: apiTypes.Snowflake, overwriteId: apiTypes.Snowflake, jsonParams: apiTypes.EditChannelPermissionsRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.EditChannelPermissionsResponse>Channel.getChannelInvitesAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetChannelInvitesResponse>Channel.createChannelInviteAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.CreateChannelInviteRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.CreateChannelInviteResponse>Channel.deleteChannelPermissionAsync(instance: request.Request, channelId: apiTypes.Snowflake, overwriteId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteChannelPermissionResponse>Channel.followAnnouncementChannelAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.FollowAnnouncementChannelRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.FollowAnnouncementChannelResponse>Channel.triggerTypingIndicatorAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.TriggerTypingIndicatorResponse>Channel.getPinnedMessagesAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetPinnedMessagesResponse>Channel.pinMessageAsync(instance: request.Request, channelId: apiTypes.Snowflake, messageId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.PinMessageResponse>Channel.unpinMessageAsync(instance: request.Request, channelId: apiTypes.Snowflake, messageId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.UnpinMessageResponse>Channel.groupDMAddRecipientAsync(instance: request.Request, channelId: apiTypes.Snowflake, userId: apiTypes.Snowflake, jsonParams: apiTypes.GroupDMAddRecipientRequest) → future.FutureLike<string, apiTypes.GroupDMAddRecipientResponse>Channel.groupDMRemoveRecipientAsync(instance: request.Request, channelId: apiTypes.Snowflake, userId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GroupDMRemoveRecipientResponse>Channel.startThreadFromMessageAsync(instance: request.Request, channelId: apiTypes.Snowflake, messageId: apiTypes.Snowflake, jsonParams: apiTypes.StartThreadFromMessageRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.StartThreadFromMessageResponse>Channel.startThreadWithoutMessageAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.StartThreadWithoutMessageRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.StartThreadWithoutMessageResponse>Channel.startThreadInForumOrMediaChannelAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.StartThreadInForumOrMediaChannelRequest, auditLogReason: string?) → future.FutureLike< string, apiTypes.StartThreadInForumOrMediaChannelResponse >Channel.joinThreadAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.JoinThreadResponse>Channel.addThreadMemberAsync(instance: request.Request, channelId: apiTypes.Snowflake, userId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.AddThreadMemberResponse>Channel.leaveThreadAsync(instance: request.Request, channelId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.LeaveThreadResponse>Channel.removeThreadMemberAsync(instance: request.Request, channelId: apiTypes.Snowflake, userId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.RemoveThreadMemberResponse>Channel.getThreadMemberAsync(instance: request.Request, channelId: apiTypes.Snowflake, userId: apiTypes.Snowflake, urlParams: { withMember: boolean?, }) → future.FutureLike<string, apiTypes.GetThreadMemberResponse>Channel.listThreadMembersAsync(instance: request.Request, channelId: apiTypes.Snowflake, urlParams: { withMember: boolean?, after: apiTypes.Snowflake?, limit: number?, }) → future.FutureLike<string, apiTypes.ListThreadMembersResponse>Channel.listPublicArchivedThreadsAsync(instance: request.Request, channelId: apiTypes.Snowflake, urlParams: { before: string?, limit: number?, }) → future.FutureLike<string, apiTypes.ListPublicArchivedThreadsResponse>Channel.listPrivateArchivedThreadsAsync(instance: request.Request, channelId: apiTypes.Snowflake, urlParams: { before: string?, limit: number?, }) → future.FutureLike<string, apiTypes.ListPrivateArchivedThreadsResponse>Channel.listJoinedPrivateArchivedThreadsAsync(instance: request.Request, channelId: apiTypes.Snowflake, urlParams: { before: string?, limit: number?, }) → future.FutureLike< string, apiTypes.ListJoinedPrivateArchivedThreadsResponse >Channel.sendSoundboardSoundAsync(instance: request.Request, channelId: apiTypes.Snowflake, jsonParams: apiTypes.SendSoundboardSoundRequest) → future.FutureLike<string, apiTypes.SendSoundboardSoundResponse>Functions
Section titled “Functions”getChannelAsync
Section titled “getChannelAsync”Channel . getChannelAsync ( instance , channelId ) -> FutureLike<string, GetChannelResponse>
https://discord.com/developers/docs/resources/channel#get-channel
Parameters
| instance: Request | |
| channelId: Snowflake |
Returns
| FutureLike<string, GetChannelResponse> |
modifyChannelAsync
Section titled “modifyChannelAsync”Channel . modifyChannelAsync ( instance , channelId , jsonParams , auditLogReason ) -> FutureLike<string, ModifyChannelResponse>
https://discord.com/developers/docs/resources/channel#modify-channel
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: ModifyChannelRequest | |
| auditLogReason: string? |
Returns
| FutureLike<string, ModifyChannelResponse> |
deleteOrCloseChannelAsync
Section titled “deleteOrCloseChannelAsync”Channel . deleteOrCloseChannelAsync ( instance , channelId , auditLogReason ) -> FutureLike<string, DeleteCloseChannelResponse>
https://discord.com/developers/docs/resources/channel#deleteclose-channel
Parameters
| instance: Request | |
| channelId: Snowflake | |
| auditLogReason: string? |
Returns
| FutureLike<string, DeleteCloseChannelResponse> |
editChannelPermissionsAsync
Section titled “editChannelPermissionsAsync”Channel . editChannelPermissionsAsync ( instance , channelId , overwriteId , jsonParams , auditLogReason ) -> FutureLike<string, EditChannelPermissionsResponse>
https://discord.com/developers/docs/resources/channel#edit-channel-permissions
Parameters
| instance: Request | |
| channelId: Snowflake | |
| overwriteId: Snowflake | |
| jsonParams: EditChannelPermissionsRequest | |
| auditLogReason: string? |
getChannelInvitesAsync
Section titled “getChannelInvitesAsync”Channel . getChannelInvitesAsync ( instance , channelId ) -> FutureLike<string, GetChannelInvitesResponse>
https://discord.com/developers/docs/resources/channel#get-channel-invites
Parameters
| instance: Request | |
| channelId: Snowflake |
Returns
| FutureLike<string, GetChannelInvitesResponse> |
createChannelInviteAsync
Section titled “createChannelInviteAsync”Channel . createChannelInviteAsync ( instance , channelId , jsonParams , auditLogReason ) -> FutureLike<string, CreateChannelInviteResponse>
https://discord.com/developers/docs/resources/channel#create-channel-invite
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: CreateChannelInviteRequest | |
| auditLogReason: string? |
Returns
| FutureLike<string, CreateChannelInviteResponse> |
deleteChannelPermissionAsync
Section titled “deleteChannelPermissionAsync”Channel . deleteChannelPermissionAsync ( instance , channelId , overwriteId , auditLogReason ) -> FutureLike<string, DeleteChannelPermissionResponse>
https://discord.com/developers/docs/resources/channel#delete-channel-permission
Parameters
| instance: Request | |
| channelId: Snowflake | |
| overwriteId: Snowflake | |
| auditLogReason: string? |
followAnnouncementChannelAsync
Section titled “followAnnouncementChannelAsync”Channel . followAnnouncementChannelAsync ( instance , channelId , jsonParams , auditLogReason ) -> FutureLike<string, FollowAnnouncementChannelResponse>
https://discord.com/developers/docs/resources/channel#follow-announcement-channel
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: FollowAnnouncementChannelRequest | |
| auditLogReason: string? |
triggerTypingIndicatorAsync
Section titled “triggerTypingIndicatorAsync”Channel . triggerTypingIndicatorAsync ( instance , channelId ) -> FutureLike<string, TriggerTypingIndicatorResponse>
https://discord.com/developers/docs/resources/channel#trigger-typing-indicator
Parameters
| instance: Request | |
| channelId: Snowflake |
getPinnedMessagesAsync
Section titled “getPinnedMessagesAsync”Channel . getPinnedMessagesAsync ( instance , channelId ) -> FutureLike<string, GetPinnedMessagesResponse>
https://discord.com/developers/docs/resources/channel#get-pinned-messages
Parameters
| instance: Request | |
| channelId: Snowflake |
Returns
| FutureLike<string, GetPinnedMessagesResponse> |
pinMessageAsync
Section titled “pinMessageAsync”Channel . pinMessageAsync ( instance , channelId , messageId , auditLogReason ) -> FutureLike<string, PinMessageResponse>
https://discord.com/developers/docs/resources/channel#pin-message
Parameters
| instance: Request | |
| channelId: Snowflake | |
| messageId: Snowflake | |
| auditLogReason: string? |
Returns
| FutureLike<string, PinMessageResponse> |
unpinMessageAsync
Section titled “unpinMessageAsync”Channel . unpinMessageAsync ( instance , channelId , messageId , auditLogReason ) -> FutureLike<string, UnpinMessageResponse>
https://discord.com/developers/docs/resources/channel#unpin-message
Parameters
| instance: Request | |
| channelId: Snowflake | |
| messageId: Snowflake | |
| auditLogReason: string? |
Returns
| FutureLike<string, UnpinMessageResponse> |
groupDMAddRecipientAsync
Section titled “groupDMAddRecipientAsync”Channel . groupDMAddRecipientAsync ( instance , channelId , userId , jsonParams ) -> FutureLike<string, GroupDMAddRecipientResponse>
https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
Parameters
| instance: Request | |
| channelId: Snowflake | |
| userId: Snowflake | |
| jsonParams: GroupDMAddRecipientRequest |
Returns
| FutureLike<string, GroupDMAddRecipientResponse> |
groupDMRemoveRecipientAsync
Section titled “groupDMRemoveRecipientAsync”Channel . groupDMRemoveRecipientAsync ( instance , channelId , userId ) -> FutureLike<string, GroupDMRemoveRecipientResponse>
https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient
Parameters
| instance: Request | |
| channelId: Snowflake | |
| userId: Snowflake |
startThreadFromMessageAsync
Section titled “startThreadFromMessageAsync”Channel . startThreadFromMessageAsync ( instance , channelId , messageId , jsonParams , auditLogReason ) -> FutureLike<string, StartThreadFromMessageResponse>
https://discord.com/developers/docs/resources/channel#start-thread-from-message
Parameters
| instance: Request | |
| channelId: Snowflake | |
| messageId: Snowflake | |
| jsonParams: StartThreadFromMessageRequest | |
| auditLogReason: string? |
startThreadWithoutMessageAsync
Section titled “startThreadWithoutMessageAsync”Channel . startThreadWithoutMessageAsync ( instance , channelId , jsonParams , auditLogReason ) -> FutureLike<string, StartThreadWithoutMessageResponse>
https://discord.com/developers/docs/resources/channel#start-thread-without-message
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: StartThreadWithoutMessageRequest | |
| auditLogReason: string? |
startThreadInForumOrMediaChannelAsync
Section titled “startThreadInForumOrMediaChannelAsync”Channel . startThreadInForumOrMediaChannelAsync ( instance , channelId , jsonParams , auditLogReason ) -> FutureLike< string, StartThreadInForumOrMediaChannelResponse >
https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: StartThreadInForumOrMediaChannelRequest | |
| auditLogReason: string? |
joinThreadAsync
Section titled “joinThreadAsync”Channel . joinThreadAsync ( instance , channelId ) -> FutureLike<string, JoinThreadResponse>
https://discord.com/developers/docs/resources/channel#join-thread
Parameters
| instance: Request | |
| channelId: Snowflake |
Returns
| FutureLike<string, JoinThreadResponse> |
addThreadMemberAsync
Section titled “addThreadMemberAsync”Channel . addThreadMemberAsync ( instance , channelId , userId ) -> FutureLike<string, AddThreadMemberResponse>
https://discord.com/developers/docs/resources/channel#add-thread-member
Parameters
| instance: Request | |
| channelId: Snowflake | |
| userId: Snowflake |
Returns
| FutureLike<string, AddThreadMemberResponse> |
leaveThreadAsync
Section titled “leaveThreadAsync”Channel . leaveThreadAsync ( instance , channelId ) -> FutureLike<string, LeaveThreadResponse>
https://discord.com/developers/docs/resources/channel#leave-thread
Parameters
| instance: Request | |
| channelId: Snowflake |
Returns
| FutureLike<string, LeaveThreadResponse> |
removeThreadMemberAsync
Section titled “removeThreadMemberAsync”Channel . removeThreadMemberAsync ( instance , channelId , userId ) -> FutureLike<string, RemoveThreadMemberResponse>
https://discord.com/developers/docs/resources/channel#remove-thread-member
Parameters
| instance: Request | |
| channelId: Snowflake | |
| userId: Snowflake |
Returns
| FutureLike<string, RemoveThreadMemberResponse> |
getThreadMemberAsync
Section titled “getThreadMemberAsync”Channel . getThreadMemberAsync ( instance , channelId , userId , urlParams ) -> FutureLike<string, GetThreadMemberResponse>
https://discord.com/developers/docs/resources/channel#get-thread-member
Parameters
| instance: Request | |
| channelId: Snowflake | |
| userId: Snowflake | |
| urlParams: { { withMember: boolean?, } } |
Returns
| FutureLike<string, GetThreadMemberResponse> |
listThreadMembersAsync
Section titled “listThreadMembersAsync”Channel . listThreadMembersAsync ( instance , channelId , urlParams ) -> FutureLike<string, ListThreadMembersResponse>
https://discord.com/developers/docs/resources/channel#list-thread-members
Parameters
| instance: Request | |
| channelId: Snowflake | |
| urlParams: { withMember: boolean?, after: apiTypes.Snowflake?, limit: number?, } |
Returns
| FutureLike<string, ListThreadMembersResponse> |
listPublicArchivedThreadsAsync
Section titled “listPublicArchivedThreadsAsync”Channel . listPublicArchivedThreadsAsync ( instance , channelId , urlParams ) -> FutureLike<string, ListPublicArchivedThreadsResponse>
https://discord.com/developers/docs/resources/channel#list-public-archived-threads
listPrivateArchivedThreadsAsync
Section titled “listPrivateArchivedThreadsAsync”Channel . listPrivateArchivedThreadsAsync ( instance , channelId , urlParams ) -> FutureLike<string, ListPrivateArchivedThreadsResponse>
https://discord.com/developers/docs/resources/channel#list-private-archived-threads
listJoinedPrivateArchivedThreadsAsync
Section titled “listJoinedPrivateArchivedThreadsAsync”Channel . listJoinedPrivateArchivedThreadsAsync ( instance , channelId , urlParams ) -> FutureLike< string, ListJoinedPrivateArchivedThreadsResponse >
https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads
sendSoundboardSoundAsync
Section titled “sendSoundboardSoundAsync”Channel . sendSoundboardSoundAsync ( instance , channelId , jsonParams ) -> FutureLike<string, SendSoundboardSoundResponse>
https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound
Parameters
| instance: Request | |
| channelId: Snowflake | |
| jsonParams: SendSoundboardSoundRequest |
Returns
| FutureLike<string, SendSoundboardSoundResponse> |