Class GroupChannel

Represents a group direct message.

Hierarchy

Channel
- GroupChannel

Index

Constructors

constructor

new GroupChannel(data: RawGroupChannel, client: Client<ClientEvents>): GroupChannel
Parameters
- data: RawGroupChannel
- client: Client<ClientEvents>
Returns GroupChannel
Overrides Channel.constructor
- Defined in lib/structures/GroupChannel.ts:36

Properties

`Optional` application

application?: ClientApplication

The application that made this group channel.

applicationID

applicationID: string

The ID of the application that made this group channel.

client

client: Client<ClientEvents>

icon

icon: null | string

The icon hash of this group, if any.

id

id: string

lastMessageID

lastMessageID: null | string

The ID of last message sent in this channel.

managed

managed: boolean

If this group channel is managed by an application.

name

name: null | string

The name of this group channel.

nicks

nicks: Record<"id" | "nick", string>[]

The nicknames used when creating this group channel.

`Optional` owner

owner?: User

The owner of this group channel.

ownerID

ownerID: string

The ID of the owner of this group channel.

recipients

recipients: TypedCollection<string, RawUser, User, []>

The other recipients in this group channel.

type

type: GROUP_DM

The type of this channel.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Channel.createdAt
- Defined in lib/structures/Base.ts:31

mention

get mention(): string
A string that will mention this channel.

Returns string
Inherited from Channel.mention
- Defined in lib/structures/Channel.ts:73

Methods

addRecipient

addRecipient(options: AddGroupRecipientOptions): Promise<void>
Add a user to this channel.
Parameters
- options: AddGroupRecipientOptions
  
  The options for adding the user.
Returns Promise<void>
- Defined in lib/structures/GroupChannel.ts:100

delete

delete(): Promise<void>
Close a direct message, leave a group channel, or delete a guild channel.

Returns Promise<void>
Inherited from Channel.delete
- Defined in lib/structures/Channel.ts:80

edit

edit(options: EditGroupDMOptions): Promise<GroupChannel>
Edit this channel.
Parameters
- options: EditGroupDMOptions
  
  The options for editing the channel.
Returns Promise<GroupChannel>
- Defined in lib/structures/GroupChannel.ts:108

iconURL

iconURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): null | string
The url of this application's icon.
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
  
  The format the url should be.
- Optional size: number
  
  The dimensions of the image.
Returns null | string
- Defined in lib/structures/GroupChannel.ts:117

removeRecipient

removeRecipient(userID: string): Promise<void>
Remove a user from this channel.
Parameters
- userID: string
  
  The ID of the user to remove.
Returns Promise<void>
- Defined in lib/structures/GroupChannel.ts:125

sendTyping

sendTyping(): Promise<void>
Show a typing indicator in this channel.

Returns Promise<void>
- Defined in lib/structures/GroupChannel.ts:132

toJSON

toJSON(): JSONGroupChannel
Returns JSONGroupChannel
Overrides Channel.toJSON
- Defined in lib/structures/GroupChannel.ts:136

toString

toString(): string
Returns string
Inherited from Channel.toString
- Defined in lib/structures/Base.ts:56

`Static` from

from<T>(data: RawChannel, client: Client<ClientEvents>): T
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- data: RawChannel
- client: Client<ClientEvents>
Returns T
Inherited from Channel.from
- Defined in lib/structures/Channel.ts:31

`Static` getCreatedAt

getCreatedAt(id: string): Date
Parameters
- id: string
Returns Date
Inherited from Channel.getCreatedAt
- Defined in lib/structures/Base.ts:20

`Static` getDiscordEpoch

getDiscordEpoch(id: string): number
Parameters
- id: string
Returns number
Inherited from Channel.getDiscordEpoch
- Defined in lib/structures/Base.ts:24

Class GroupChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawGroupChannel

client: Client<ClientEvents>

Returns GroupChannel

Properties

Optional application

applicationID

client

icon

id

lastMessageID

managed

name

nicks

Optional owner

ownerID

recipients

type

Accessors

createdAt

Returns Date

mention

Returns string

Methods

addRecipient

Parameters

options: AddGroupRecipientOptions

Returns Promise<void>

delete

Returns Promise<void>

edit

Parameters

options: EditGroupDMOptions

Returns Promise<GroupChannel>

iconURL

Parameters

Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

Optional size: number

Returns null | string

removeRecipient

Parameters

userID: string

Returns Promise<void>

sendTyping

Returns Promise<void>

toJSON

Returns JSONGroupChannel

toString

Returns string

Static from

Type Parameters

T extends AnyChannel = AnyChannel

Parameters

data: RawChannel

client: Client<ClientEvents>

Returns T

Static getCreatedAt

Parameters

id: string

Returns Date

Static getDiscordEpoch

Parameters

id: string

Returns number

Settings

Member Visibility

Theme

`Optional` application

`Optional` owner

`Optional` format: "jpg" | "jpeg" | "png" | "webp" | "gif"

`Optional` size: number

`Static` from

`Static` getCreatedAt

`Static` getDiscordEpoch