Class MessageCollection

Readonly filter

channel

• get channel(): Channel

• The channel of the messages.

  Returns Channel

failedMessages

• get failedMessages(): (UserMessage | FileMessage | MultipleFilesMessage)[]

• The failed message lists.

  Returns (UserMessage | FileMessage | MultipleFilesMessage)[]

hasNext

• get hasNext(): boolean

• Whether there's more data to load in next (latest) direction.

  Returns boolean

hasPrevious

• get hasPrevious(): boolean

• Whether there's more data to load in previous (oldest) direction.

  Returns boolean

pendingMessages

• get pendingMessages(): (UserMessage | FileMessage | MultipleFilesMessage)[]

• The pending message lists.

  Returns (UserMessage | FileMessage | MultipleFilesMessage)[]

succeededMessages

• get succeededMessages(): Message[]

• The list of succeeded message list in this collection.

  Returns Message[]

dispose

• dispose(): void

• Returns void

  Description

  Disposes current BaseMessageCollection and stops all events from being received.

loadNext

• loadNext(): Promise<BaseMessage[]>

• Returns Promise<BaseMessage[]>

  Description

  Loads next (latest direction) message lists.

loadPrevious

• loadPrevious(): Promise<BaseMessage[]>

• Returns Promise<BaseMessage[]>

  Description

  Loads previous (oldest direction) message lists.

removeFailedMessage

• removeFailedMessage(reqId): Promise<void>

• Parameters

  • reqId: string

  Returns Promise<void>

  Description

  Remove specific failed message of the channel.