Class PrivateChannel

Hierarchy

Channel
- PrivateChannel
  - GroupChannel

Implements

Textable

Index

Constructors

constructor

Properties

Constructors

constructor

new PrivateChannel(data: BaseData): PrivateChannel

Inherited from Channel.constructor
- Defined in node_modules/eris/index.d.ts:1426
Parameters
- data: BaseData
Returns PrivateChannel

Properties

client

client: Client

createdAt

createdAt: number

id

id: string

lastMessageID

lastMessageID: string

mention

mention: string

messages

messages: Collection<Message<PrivateChannel>>

recipient

recipient: User

type

type: 1 | 3

Methods

addMessageReaction

addMessageReaction(messageID: string, reaction: string): Promise<void>
addMessageReaction(messageID: string, reaction: string, userID: string): Promise<void>

Implementation of Textable.addMessageReaction
- Defined in node_modules/eris/index.d.ts:2328
Parameters
- messageID: string
- reaction: string
Returns Promise<void>
Implementation of Textable.addMessageReaction
- Defined in node_modules/eris/index.d.ts:2330
deprecated

Parameters
- messageID: string
- reaction: string
- userID: string
Returns Promise<void>

createMessage

createMessage(content: MessageContent, file?: MessageFile | MessageFile[]): Promise<Message<PrivateChannel>>

Implementation of Textable.createMessage
- Defined in node_modules/eris/index.d.ts:2331
Parameters
- content: MessageContent
- Optional file: MessageFile | MessageFile[]
Returns Promise<Message<PrivateChannel>>

deleteMessage

deleteMessage(messageID: string, reason?: string): Promise<void>

Implementation of Textable.deleteMessage
- Defined in node_modules/eris/index.d.ts:2332
Parameters
- messageID: string
- Optional reason: string
Returns Promise<void>

editMessage

editMessage(messageID: string, content: MessageContent): Promise<Message<PrivateChannel>>

Implementation of Textable.editMessage
- Defined in node_modules/eris/index.d.ts:2333
Parameters
- messageID: string
- content: MessageContent
Returns Promise<Message<PrivateChannel>>

getMessage

getMessage(messageID: string): Promise<Message<PrivateChannel>>

Implementation of Textable.getMessage
- Defined in node_modules/eris/index.d.ts:2334
Parameters
- messageID: string
Returns Promise<Message<PrivateChannel>>

getMessageReaction

getMessageReaction(messageID: string, reaction: string, options?: GetMessageReactionOptions): Promise<User[]>
getMessageReaction(messageID: string, reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>

Implementation of Textable.getMessageReaction
- Defined in node_modules/eris/index.d.ts:2335
Parameters
- messageID: string
- reaction: string
- Optional options: GetMessageReactionOptions
Returns Promise<User[]>
Implementation of Textable.getMessageReaction
- Defined in node_modules/eris/index.d.ts:2337
deprecated

Parameters
- messageID: string
- reaction: string
- Optional limit: number
- Optional before: string
- Optional after: string
Returns Promise<User[]>

getMessages

getMessages(options?: GetMessagesOptions): Promise<Message<PrivateChannel>[]>
getMessages(limit?: number, before?: string, after?: string, around?: string): Promise<Message<PrivateChannel>[]>

Implementation of Textable.getMessages
- Defined in node_modules/eris/index.d.ts:2338
Parameters
- Optional options: GetMessagesOptions
Returns Promise<Message<PrivateChannel>[]>
Implementation of Textable.getMessages
- Defined in node_modules/eris/index.d.ts:2340
deprecated

Parameters
- Optional limit: number
- Optional before: string
- Optional after: string
- Optional around: string
Returns Promise<Message<PrivateChannel>[]>

getPins

getPins(): Promise<Message<PrivateChannel>[]>

Implementation of Textable.getPins
- Defined in node_modules/eris/index.d.ts:2341
Returns Promise<Message<PrivateChannel>[]>

inspect

inspect(): PrivateChannel

Inherited from Channel.inspect
- Defined in node_modules/eris/index.d.ts:1364
Returns PrivateChannel

leave

leave(): Promise<void>

- Defined in node_modules/eris/index.d.ts:2342
Returns Promise<void>

pinMessage

pinMessage(messageID: string): Promise<void>

Implementation of Textable.pinMessage
- Defined in node_modules/eris/index.d.ts:2343
Parameters
- messageID: string
Returns Promise<void>

removeMessageReaction

removeMessageReaction(messageID: string, reaction: string): Promise<void>
removeMessageReaction(messageID: string, reaction: string, userID: string): Promise<void>

Implementation of Textable.removeMessageReaction
- Defined in node_modules/eris/index.d.ts:2344
Parameters
- messageID: string
- reaction: string
Returns Promise<void>
Implementation of Textable.removeMessageReaction
- Defined in node_modules/eris/index.d.ts:2346
deprecated

Parameters
- messageID: string
- reaction: string
- userID: string
Returns Promise<void>

ring

ring(recipient: string[]): void

- Defined in node_modules/eris/index.d.ts:2347
Parameters
- recipient: string[]
Returns void

sendTyping

sendTyping(): Promise<void>

Implementation of Textable.sendTyping
- Defined in node_modules/eris/index.d.ts:2348
Returns Promise<void>

syncCall

syncCall(): void

- Defined in node_modules/eris/index.d.ts:2349
Returns void

toJSON

toJSON(props?: string[]): JSONCache

Inherited from Channel.toJSON
- Defined in node_modules/eris/index.d.ts:1366
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

Inherited from Channel.toString
- Defined in node_modules/eris/index.d.ts:1365
Returns string

unpinMessage

unpinMessage(messageID: string): Promise<void>

Implementation of Textable.unpinMessage
- Defined in node_modules/eris/index.d.ts:2350
Parameters
- messageID: string
Returns Promise<void>

unsendMessage

unsendMessage(messageID: string): Promise<void>

Implementation of Textable.unsendMessage
- Defined in node_modules/eris/index.d.ts:2351
Parameters
- messageID: string
Returns Promise<void>

Static from

from(data: BaseData, client: Client): AnyChannel

Inherited from Channel.from
- Defined in node_modules/eris/index.d.ts:1427
Parameters
- data: BaseData
- client: Client
Returns AnyChannel

Static getCreatedAt

getCreatedAt(id: string): number

Inherited from Channel.getCreatedAt
- Defined in node_modules/eris/index.d.ts:1363
Parameters
- id: string
Returns number

Generated using TypeDoc