Class PrivateChannel

Represents a direct message with a user.

Hierarchy (view full)

Channel
- PrivateChannel

Index

Constructors

constructor

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

Properties

client

client: Client<ClientEvents>

id

id: string

`Optional` lastMessage

lastMessage?: null | Message<PrivateChannel>

The last message sent in this channel. This will only be present if a message has been sent within the current session.

lastMessageID

lastMessageID: null | string

The ID of last message sent in this channel.

messages

messages: TypedCollection<RawMessage, Message<PrivateChannel>, []>

The cached messages in this channel.

recipient

recipient: User

The other user in this direct message.

type

type: DM

The type of this channel.

Accessors

createdAt

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

mention

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

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

Methods

createMessage

createMessage(options): Promise<Message<PrivateChannel>>
Create a message in this channel.
Parameters
- options: CreateMessageOptions
  The options for creating the message.
Returns Promise<Message<PrivateChannel>>
- Defined in lib/structures/PrivateChannel.ts:47

createReaction

createReaction(messageID, emoji): Promise<void>
Add a reaction to a message in this channel.
Parameters
- messageID: string
  The ID of the message to add a reaction to.
- emoji: string
  The reaction to add to the message. name:id for custom emojis, and the unicode codepoint for default emojis.
Returns Promise<void>
- Defined in lib/structures/PrivateChannel.ts:56

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:84

deleteMessage

deleteMessage(messageID, reason?): Promise<void>
Delete a message in this channel.
Parameters
- messageID: string
  The ID of the message to delete.
- Optional reason: string
  The reason for deleting the message.
Returns Promise<void>
- Defined in lib/structures/PrivateChannel.ts:65

deleteReaction

deleteReaction(messageID, emoji): Promise<void>
Remove a reaction from a message in this channel.
Parameters
- messageID: string
  The ID of the message to remove a reaction from.
- emoji: string
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
Returns Promise<void>
- Defined in lib/structures/PrivateChannel.ts:74

editMessage

editMessage(messageID, options): Promise<Message<PrivateChannel>>
Edit a message in this channel.
Parameters
- messageID: string
  The ID of the message to edit.
- options: EditMessageOptions
  The options for editing the message.
Returns Promise<Message<PrivateChannel>>
- Defined in lib/structures/PrivateChannel.ts:83

getMessage

getMessage(messageID): Promise<Message<PrivateChannel>>
Get a message in this channel.
Parameters
- messageID: string
  The ID of the message to get.
Returns Promise<Message<PrivateChannel>>
- Defined in lib/structures/PrivateChannel.ts:91

getMessages

getMessages(options?): Promise<Message<PrivateChannel>[]>
Get messages in this channel.
Parameters
- Optional options: GetChannelMessagesOptions<Uncached | AnyTextableChannel>
  The options for getting the messages. before, after, and around All are mutually exclusive.
Returns Promise<Message<PrivateChannel>[]>
- Defined in lib/structures/PrivateChannel.ts:99

getPinnedMessages

getPinnedMessages(): Promise<Message<PrivateChannel>[]>
Get the pinned messages in this channel.

Returns Promise<Message<PrivateChannel>[]>
- Defined in lib/structures/PrivateChannel.ts:106

getReactions

getReactions(messageID, emoji, options?): Promise<User[]>
Get the users who reacted with a specific emoji on a message.
Parameters
- messageID: string
  The iIDd of the message to get reactions from.
- emoji: string
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- Optional options: GetReactionsOptions
  The options for getting the reactions.
Returns Promise<User[]>
- Defined in lib/structures/PrivateChannel.ts:116

pinMessage

pinMessage(messageID, reason?): Promise<void>
Pin a message in this channel.
Parameters
- messageID: string
  The ID of the message to pin.
- Optional reason: string
  The reason for pinning the message.
Returns Promise<void>
- Defined in lib/structures/PrivateChannel.ts:125

sendTyping

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

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

toJSON

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

toString

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

unpinMessage

unpinMessage(messageID, reason?): Promise<void>
Unpin a message in this channel.
Parameters
- messageID: string
  The ID of the message to unpin.
- Optional reason: string
  The ID for unpinning the message.
Returns Promise<void>
- Defined in lib/structures/PrivateChannel.ts:151

`Static` from

from<T>(data, client): 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:32

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Channel.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

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

`Static` getDiscordEpoch

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

Class PrivateChannel

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawPrivateChannel

client: Client<ClientEvents>

Returns PrivateChannel

Properties

client

id

Optional lastMessage

lastMessageID

messages

recipient

type

Accessors

createdAt

Returns Date

mention

Returns string

Methods

createMessage

Parameters

options: CreateMessageOptions

Returns Promise<Message<PrivateChannel>>

createReaction

Parameters

messageID: string

emoji: string

Returns Promise<void>

delete

Returns Promise<void>

deleteMessage

Parameters

messageID: string

Optional reason: string

Returns Promise<void>

deleteReaction

Parameters

messageID: string

emoji: string

Returns Promise<void>

editMessage

Parameters

messageID: string

options: EditMessageOptions

Returns Promise<Message<PrivateChannel>>

getMessage

Parameters

messageID: string

Returns Promise<Message<PrivateChannel>>

getMessages

Parameters

Optional options: GetChannelMessagesOptions<Uncached | AnyTextableChannel>

Returns Promise<Message<PrivateChannel>[]>

getPinnedMessages

Returns Promise<Message<PrivateChannel>[]>

getReactions

Parameters

messageID: string

emoji: string

Optional options: GetReactionsOptions

Returns Promise<User[]>

pinMessage

Parameters

messageID: string

Optional reason: string

Returns Promise<void>

sendTyping

Returns Promise<void>

toJSON

Returns JSONPrivateChannel

toString

Returns string

`Optional` lastMessage

`Optional` reason: string

`Optional` options: GetChannelMessagesOptions<Uncached | AnyTextableChannel>

`Optional` options: GetReactionsOptions

`Optional` reason: string

`Optional` reason: string

`Static` from

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch