Class Message

API Message model.

Hierarchy

default<APIMessage>
- Message

Index

Constructors

Properties

attachments author channel client content createdAt id

Methods

_clone _patch _update delete fetch toJson

Constructors

constructor

new Message(client: Client, data: APIMessage, channel: Channel): Message
Parameters
- client: Client
- data: APIMessage
- channel: Channel
  The channel the message was sent in.
Returns Message
Overrides Data<APIMessage>.constructor
- Defined in packages/foxochat.js/src/models/Message.ts:32

Properties

attachments

attachments: Map<number, Attachment>

The files attached to the message.

author

author: Member

The author of the message.

`Readonly`channel

channel: Channel

The channel the message was sent in.

`Readonly`client

client: Client

The client that instantiated this Model.

content

content: string

The content of the message.

createdAt

createdAt: Date

The time when message sent at.

`Readonly`id

id: number

The id of the model.

Methods

_clone

_clone(): Message
Returns Message
Inherited from Data._clone
- Defined in packages/foxochat.js/src/models/Base.ts:17

_patch

_patch(data: Partial<APIMessage>): void
Parameters
- data: Partial<APIMessage>
Returns void
Overrides Data._patch
- Defined in packages/foxochat.js/src/models/Message.ts:45

_update

_update(data: Partial<T>): Message
Parameters
- data: Partial<T>
Returns Message
Inherited from Data._update
- Defined in packages/foxochat.js/src/models/Base.ts:21

delete

delete(): Promise<Message>
Deletes the message.

Returns Promise<Message>
- Defined in packages/foxochat.js/src/models/Message.ts:69

fetch

fetch(force?: boolean): Promise<Message>
Fetch this message.
Parameters
- force: boolean = true
Returns Promise<Message>
- Defined in packages/foxochat.js/src/models/Message.ts:62

toJson

toJson(): APIMessage
Returns APIMessage
Overrides Data.toJson
- Defined in packages/foxochat.js/src/models/Message.ts:74