Class ChatMessage

Instances of this class represents a message of the chat. For more information about how instances of this class can be obtained see Chat#getMessages or Chat#getPendingMessages.

Index

Constructors

Properties

composer data direction id? progress status timestamp? type

Methods

getComposer getData getDirection getId getProgress getStatus getTimestamp getType hasStatus

Constructors

`Private` constructor

new ChatMessage(composer, data, direction, type, status, progress, id?, timestamp?): ChatMessage
Parameters
- composer: string
- data: string | ChatMessageFile
- direction: ChatMessageDirection
- type: ChatMessageType
- status: ChatMessageStatus
- progress: number
- Optional id: string
- Optional timestamp: number
Returns ChatMessage
- Defined in src/chat/ChatMessage.ts:42

Properties

`Private` composer

composer: string

`Private` data

data: string | ChatMessageFile

`Private` direction

direction: ChatMessageDirection

`Private` `Optional` id

id?: string

`Private` progress

progress: number

`Private` status

status: ChatMessageStatus

`Private` `Optional` timestamp

timestamp?: number

`Private` type

type: ChatMessageType

Methods

getComposer

getComposer(): string
Returns the address of the composer of the message.

Returns string
- Defined in src/chat/ChatMessage.ts:110

getData

getData(): string | ChatMessageFile
Returns the data of the message.

Returns string | ChatMessageFile
- Defined in src/chat/ChatMessage.ts:117

getDirection

getDirection(): ChatMessageDirection
Returns the direction of the message.

Returns ChatMessageDirection
- Defined in src/chat/ChatMessage.ts:96

getId

getId(): undefined | string
Returns the ID of the message.

Returns undefined | string
- Defined in src/chat/ChatMessage.ts:89

getProgress

getProgress(): number
Returns a number between 0 and 100 indicating the percentage of the message that was sent. Note that text messages can only have two values: 0 and 100.

Returns number
- Defined in src/chat/ChatMessage.ts:132

getStatus

getStatus(): ChatMessageStatus
Returns the current status of the message.

Returns ChatMessageStatus
- Defined in src/chat/ChatMessage.ts:139

getTimestamp

getTimestamp(): undefined | number
Returns the timestamp when the message was sent.

Returns undefined | number
- Defined in src/chat/ChatMessage.ts:124

getType

getType(): ChatMessageType
Returns the type of the message.

Returns ChatMessageType
- Defined in src/chat/ChatMessage.ts:103

hasStatus

hasStatus(status): boolean
Returns true when the current status of the message is the specified.
Parameters
- status: ChatMessageStatus
Returns boolean
- Defined in src/chat/ChatMessage.ts:146