Channel | revolt.js

Hierarchy

Channel

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Channel(client: Client, data: { _id: string; channel_type: "SavedMessages"; user: string } | { _id: string; active: boolean; channel_type: "DirectMessage"; last_message_id?: null | string; recipients: string[] } | { _id: string; channel_type: "Group"; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; owner: string; permissions?: null | number; recipients: string[] } | { _id: string; channel_type: "TextChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; role_permissions?: {}; server: string } | { _id: string; channel_type: "VoiceChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; name: string; nsfw?: boolean; role_permissions?: {}; server: string }): Channel

- Defined in src/maps/Channels.ts:262
Parameters
- client: Client
- data: { _id: string; channel_type: "SavedMessages"; user: string } | { _id: string; active: boolean; channel_type: "DirectMessage"; last_message_id?: null | string; recipients: string[] } | { _id: string; channel_type: "Group"; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; owner: string; permissions?: null | number; recipients: string[] } | { _id: string; channel_type: "TextChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; role_permissions?: {}; server: string } | { _id: string; channel_type: "VoiceChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; name: string; nsfw?: boolean; role_permissions?: {}; server: string }
Returns Channel

Properties

_id

_id: string

Private Optional ackLimit

ackLimit: number

Private Optional ackTimeout

ackTimeout: number

active

active: Nullable<boolean> = null

Whether this DM is active.

requires: DirectMessage

channel_type

channel_type: "Group" | "SavedMessages" | "DirectMessage" | "TextChannel" | "VoiceChannel"

client

client: Client

default_permissions

default_permissions: Nullable<{ a: number; d: number }> = null

Default server channel permissions.

requires: TextChannel, VoiceChannel

description

description: Nullable<string> = null

Channel description.

requires: Group, TextChannel, VoiceChannel

icon

icon: Nullable<{ _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }> = null

Channel icon.

requires: Group, TextChannel, VoiceChannel

last_message_id

last_message_id: Nullable<string> = null

Id of last message in channel.

requires: Group, DM, TextChannel, VoiceChannel

name

name: Nullable<string> = null

Channel name.

requires: Group, TextChannel, VoiceChannel

nsfw

nsfw: Nullable<boolean> = null

Channel is not safe for work.

requires: Group, TextChannel, VoiceChannel

owner_id

owner_id: Nullable<string> = null

The ID of the group owner.

requires: Group

permissions

permissions: Nullable<number> = null

Permissions for group members.

requires: Group

recipient_ids

recipient_ids: Nullable<string[]> = null

Group / DM members.

requires: Group, DM

role_permissions

role_permissions: Nullable<{}> = null

Channel permissions for each role.

requires: TextChannel, VoiceChannel

server_id

server_id: Nullable<string> = null

The ID of the server this channel is in.

requires: TextChannel, VoiceChannel

typing_ids

typing_ids: Set<string> = ...

Users typing in channel.

Accessors

createdAt

get createdAt(): number

- Defined in src/maps/Channels.ts:181
Get timestamp when this channel was created.

Returns number

last_message

get last_message(): undefined | Message

- Defined in src/maps/Channels.ts:146
Last message sent in this channel.

requires

Group, DM, TextChannel, VoiceChannel

Returns undefined | Message

last_message_id_or_past

get last_message_id_or_past(): string

- Defined in src/maps/Channels.ts:157
Get the last message ID if it is present or the origin timestamp. TODO: deprecate

Returns string

mentions

get mentions(): string[]

- Defined in src/maps/Channels.ts:253
Get mentions in this channel for user.

Returns string[]

owner

get owner(): undefined | User

- Defined in src/maps/Channels.ts:115
The group owner.

requires

Group

Returns undefined | User

path

get path(): string

- Defined in src/maps/Channels.ts:197
Absolute pathname to this channel in the client.

Returns string

permission

get permission(): number

- Defined in src/maps/Channels.ts:686
Permission the currently authenticated user has against this channel

Returns number

recipient

get recipient(): undefined | User

- Defined in src/maps/Channels.ts:133
The DM recipient.

requires

DM

Returns undefined | User

recipients

get recipients(): undefined | (undefined | User)[]

- Defined in src/maps/Channels.ts:165
Group recipients.

requires

Group

Returns undefined | (undefined | User)[]

server

get server(): undefined | Server

- Defined in src/maps/Channels.ts:124
Server this channel belongs to.

requires

Server

Returns undefined | Server

typing

get typing(): (undefined | User)[]

- Defined in src/maps/Channels.ts:172
Users typing.

Returns (undefined | User)[]

unread

get unread(): boolean

- Defined in src/maps/Channels.ts:235
Get whether this channel is unread.

Returns boolean

updatedAt

get updatedAt(): number

- Defined in src/maps/Channels.ts:188
Get timestamp when this channel last had a message sent or when it was created

Returns number

url

get url(): string

- Defined in src/maps/Channels.ts:208
Get URL to this channel.

Returns string

Methods

ack

ack(message?: string | Message, skipRateLimiter?: boolean): Promise<void>

- Defined in src/maps/Channels.ts:615
Mark a channel as read

Parameters
- Optional message: string | Message
  
  Last read message or its ID
- Optional skipRateLimiter: boolean
  
  Whether to skip the internal rate limiter
Returns Promise<void>

addMember

addMember(user_id: string): Promise<undefined>

- Defined in src/maps/Channels.ts:424
Add a user to a group

Parameters
- user_id: string
  
  ID of the target user
Returns Promise<undefined>

createInvite

createInvite(): Promise<{ _id: string; channel: string; creator: string; server: string; type: "Server" } | { _id: string; channel: string; creator: string; type: "Group" }>

- Defined in src/maps/Channels.ts:591
Create an invite to the channel

Returns Promise<{ _id: string; channel: string; creator: string; server: string; type: "Server" } | { _id: string; channel: string; creator: string; type: "Group" }>

Newly created invite code

delete

delete(leave_silently?: boolean, avoidReq?: boolean): Promise<void>

- Defined in src/maps/Channels.ts:392
Delete a channel

requires

DM, Group, TextChannel, VoiceChannel

Parameters
- Optional leave_silently: boolean
- Optional avoidReq: boolean
Returns Promise<void>

deleteMessages

deleteMessages(ids: string[]): Promise<void>

- Defined in src/maps/Channels.ts:580
Parameters
- ids: string[]
Returns Promise<void>

edit

edit(data: { archived?: null | boolean; description?: null | string; icon?: null | string; name?: null | string; nsfw?: null | boolean; owner?: null | string; remove?: null | ("Description" | "Icon" | "DefaultPermissions")[] }): Promise<void>

- Defined in src/maps/Channels.ts:382
Edit a channel

Parameters
- data: { archived?: null | boolean; description?: null | string; icon?: null | string; name?: null | string; nsfw?: null | boolean; owner?: null | string; remove?: null | ("Description" | "Icon" | "DefaultPermissions")[] }
  
  Edit data
  - Optional archived?: null | boolean
    
    description
    
    Whether this channel is archived
  - Optional description?: null | string
    
    description
    
    Channel description
  - Optional icon?: null | string
    
    description
    
    Icon
    
    Provide an Autumn attachment Id.
  - Optional name?: null | string
    
    description
    
    Channel name
  - Optional nsfw?: null | boolean
    
    description
    
    Whether this channel is age-restricted
  - Optional owner?: null | string
    
    description
    
    Group owner
  - Optional remove?: null | ("Description" | "Icon" | "DefaultPermissions")[]
Returns Promise<void>

fetchMembers

fetchMembers(): Promise<User[]>

- Defined in src/maps/Channels.ts:370
Fetch a channel's members.

requires

Group

Returns Promise<User[]>

An array of the channel's members.

fetchMessage

fetchMessage(message_id: string): Promise<Message>

- Defined in src/maps/Channels.ts:470
Fetch a message by its ID

Parameters
- message_id: string
  
  ID of the target message
Returns Promise<Message>

The message

fetchMessages

fetchMessages(params?: Omit<undefined | { after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; nearby?: null | string; sort?: null | "Relevance" | "Latest" | "Oldest" }, "include_users">): Promise<Message[]>

- Defined in src/maps/Channels.ts:483
Fetch multiple messages from a channel

Parameters
- Optional params: Omit<undefined | { after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; nearby?: null | string; sort?: null | "Relevance" | "Latest" | "Oldest" }, "include_users">
  
  Message fetching route data
Returns Promise<Message[]>

The messages

fetchMessagesWithUsers

fetchMessagesWithUsers(params?: Omit<undefined | { after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; nearby?: null | string; sort?: null | "Relevance" | "Latest" | "Oldest" }, "include_users">): Promise<{ members: undefined | Member[]; messages: Message[]; users: User[] }>

- Defined in src/maps/Channels.ts:504
Fetch multiple messages from a channel including the users that sent them

Parameters
- Optional params: Omit<undefined | { after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; nearby?: null | string; sort?: null | "Relevance" | "Latest" | "Oldest" }, "include_users">
  
  Message fetching route data
Returns Promise<{ members: undefined | Member[]; messages: Message[]; users: User[] }>

Object including messages and users

fetchStale

fetchStale(ids: string[]): Promise<{ deprecated: string[] }>

- Defined in src/maps/Channels.ts:563
Fetch stale messages

Parameters
- ids: string[]
  
  IDs of the target messages
Returns Promise<{ deprecated: string[] }>

The stale messages

generateIconURL

generateIconURL(...args: FileArgs): undefined | string

- Defined in src/maps/Channels.ts:672
Generate URL to icon for this channel

Parameters
- Rest ...args: FileArgs
  
  File parameters
Returns undefined | string

File URL

getMentions

getMentions(permit: INotificationChecker): string[]

- Defined in src/maps/Channels.ts:227
Find all message IDs of unread messages

Parameters
- permit: INotificationChecker
  
  Callback function to determine whether a channel has certain properties
Returns string[]

Array of message IDs which are unread

havePermission

havePermission(...permission: ("Video" | "Masquerade" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]): boolean

- Defined in src/maps/Channels.ts:695
Check whether we have a given permission in a channel

Parameters
- Rest ...permission: ("Video" | "Masquerade" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]
  
  Permission Names
Returns boolean

Whether we have this permission

isUnread

isUnread(permit: INotificationChecker): boolean

- Defined in src/maps/Channels.ts:217
Check whether the channel is currently unread

Parameters
- permit: INotificationChecker
  
  Callback function to determine whether a channel has certain properties
Returns boolean

Whether the channel is unread

joinCall

joinCall(): Promise<{ token: string }>

- Defined in src/maps/Channels.ts:601
Join a call in a channel

Returns Promise<{ token: string }>

Join call response data

removeMember

removeMember(user_id: string): Promise<undefined>

- Defined in src/maps/Channels.ts:434
Remove a user from a group

Parameters
- user_id: string
  
  ID of the target user
Returns Promise<undefined>

search

search(params: Omit<{ after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; query: string; sort?: "Relevance" | "Latest" | "Oldest" }, "include_users">): Promise<Message[]>

- Defined in src/maps/Channels.ts:531
Search for messages

Parameters
- params: Omit<{ after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; query: string; sort?: "Relevance" | "Latest" | "Oldest" }, "include_users">
  
  Message searching route data
Returns Promise<Message[]>

The messages

searchWithUsers

searchWithUsers(params: Omit<{ after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; query: string; sort?: "Relevance" | "Latest" | "Oldest" }, "include_users">): Promise<{ members: undefined | Member[]; messages: Message[]; users: User[] }>

- Defined in src/maps/Channels.ts:544
Search for messages including the users that sent them

Parameters
- params: Omit<{ after?: null | string; before?: null | string; include_users?: null | boolean; limit?: null | number; query: string; sort?: "Relevance" | "Latest" | "Oldest" }, "include_users">
  
  Message searching route data
Returns Promise<{ members: undefined | Member[]; messages: Message[]; users: User[] }>

The messages

sendMessage

sendMessage(data: string | { attachments?: null | string[]; content?: null | string; embeds?: null | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | string; title?: null | string; url?: null | string }[]; interactions?: null | { reactions?: null | string[]; restrict_reactions?: boolean }; masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }; nonce?: null | string; replies?: null | { id: string; mention: boolean }[] }, idempotencyKey?: string): Promise<Message>

- Defined in src/maps/Channels.ts:445
Send a message

Parameters
- data: string | { attachments?: null | string[]; content?: null | string; embeds?: null | { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | string; title?: null | string; url?: null | string }[]; interactions?: null | { reactions?: null | string[]; restrict_reactions?: boolean }; masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }; nonce?: null | string; replies?: null | { id: string; mention: boolean }[] }
  
  Either the message as a string or message sending route data
- idempotencyKey: string = ...
Returns Promise<Message>

The message

setPermissions

setPermissions(role_id?: string, permissions: { allow: number; deny: number }): Promise<{ _id: string; analytics?: boolean; banner?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; categories?: null | { channels: string[]; id: string; title: string }[]; channels: string[]; default_permissions: number; description?: null | string; discoverable?: boolean; flags?: null | number; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; name: string; nsfw?: boolean; owner: string; roles?: {}; system_messages?: null | { user_banned?: null | string; user_joined?: null | string; user_kicked?: null | string; user_left?: null | string } }>

- Defined in src/maps/Channels.ts:646
Set role permissions

Parameters
- role_id: string = "default"
  
  Role Id, set to 'default' to affect all users
- permissions: { allow: number; deny: number }
  
  Permission value
  - allow: number
    
    Format: uint64
    
    description
    
    Allow bit flags
  - deny: number
    
    Format: uint64
    
    description
    
    Disallow bit flags
Returns Promise<{ _id: string; analytics?: boolean; banner?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; categories?: null | { channels: string[]; id: string; title: string }[]; channels: string[]; default_permissions: number; description?: null | string; discoverable?: boolean; flags?: null | number; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; name: string; nsfw?: boolean; owner: string; roles?: {}; system_messages?: null | { user_banned?: null | string; user_joined?: null | string; user_kicked?: null | string; user_left?: null | string } }>

startTyping

startTyping(): void

- Defined in src/maps/Channels.ts:656
Start typing in this channel

Returns void

stopTyping

stopTyping(): void

- Defined in src/maps/Channels.ts:663
Stop typing in this channel

Returns void

update

update(data: Partial<{ _id: string; channel_type: "SavedMessages"; user: string } | { _id: string; active: boolean; channel_type: "DirectMessage"; last_message_id?: null | string; recipients: string[] } | { _id: string; channel_type: "Group"; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; owner: string; permissions?: null | number; recipients: string[] } | { _id: string; channel_type: "TextChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; role_permissions?: {}; server: string } | { _id: string; channel_type: "VoiceChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; name: string; nsfw?: boolean; role_permissions?: {}; server: string }>, clear?: ("Description" | "Icon" | "DefaultPermissions")[]): void

- Defined in src/maps/Channels.ts:310
Parameters
- data: Partial<{ _id: string; channel_type: "SavedMessages"; user: string } | { _id: string; active: boolean; channel_type: "DirectMessage"; last_message_id?: null | string; recipients: string[] } | { _id: string; channel_type: "Group"; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; owner: string; permissions?: null | number; recipients: string[] } | { _id: string; channel_type: "TextChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; last_message_id?: null | string; name: string; nsfw?: boolean; role_permissions?: {}; server: string } | { _id: string; channel_type: "VoiceChannel"; default_permissions?: null | { a: number; d: number }; description?: null | string; icon?: null | { _id: string; content_type: string; deleted?: null | boolean; filename: string; message_id?: null | string; metadata: { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }; object_id?: null | string; reported?: null | boolean; server_id?: null | string; size: number; tag: string; user_id?: null | string }; name: string; nsfw?: boolean; role_permissions?: {}; server: string }>
- clear: ("Description" | "Icon" | "DefaultPermissions")[] = []
Returns void

updateGroupJoin

updateGroupJoin(user: string): void

- Defined in src/maps/Channels.ts:347
Parameters
- user: string
Returns void

updateGroupLeave

updateGroupLeave(user: string): void

- Defined in src/maps/Channels.ts:351
Parameters
- user: string
Returns void

updateStartTyping

updateStartTyping(id: string): void

- Defined in src/maps/Channels.ts:357
Parameters
- id: string
Returns void

updateStopTyping

updateStopTyping(id: string): void

- Defined in src/maps/Channels.ts:361
Parameters
- id: string
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns Channel

Properties

_id

Private Optional ackLimit

Private Optional ackTimeout

active

channel_type

client

default_permissions

description

icon

last_message_id

name

nsfw

owner_id

permissions

recipient_ids

role_permissions

server_id

typing_ids

Accessors

createdAt

Returns number

last_message

Returns undefined | Message

last_message_id_or_past

Returns string

mentions

Returns string[]

owner

Returns undefined | User

path

Returns string

permission

Returns number

recipient

Returns undefined | User

recipients

Returns undefined | (undefined | User)[]

server

Returns undefined | Server

typing

Returns (undefined | User)[]

unread

Returns boolean

updatedAt

Returns number

url

Returns string

Methods

ack

Parameters

Optional message: string | Message

Optional skipRateLimiter: boolean

Returns Promise<void>

addMember

Parameters

user_id: string

Returns Promise<undefined>

createInvite

Returns Promise<{ _id: string; channel: string; creator: string; server: string; type: "Server" } | { _id: string; channel: string; creator: string; type: "Group" }>

delete

Parameters

Optional leave_silently: boolean

Optional avoidReq: boolean

Returns Promise<void>

deleteMessages

Parameters

ids: string[]

Returns Promise<void>