ClassMessageCollectionInitHandler<Message>

Description

An interface used in MessageCollection.initialize.

Type Parameters

Message extends MessagePrototype

Index

Constructors

Methods

onApiResult onCacheResult

Constructors

constructor

new MessageCollectionInitHandler<Message>(): MessageCollectionInitHandler<Message>
Type Parameters
- Message extends MessagePrototype<Message>
Returns MessageCollectionInitHandler<Message>

Methods

onApiResult

onApiResult(handler): MessageCollectionInitHandler<Message>
Parameters
- handler: ((err: null | Error, messages: null | Message[]) => void)
  - - (err, messages): void
    - Parameters
      err: null | Error
      messages: null | Message[]
      Returns void
Returns MessageCollectionInitHandler<Message>
Description
This will give message lists loaded from the api. Once the results are received, you should handle the data in view according to the MessageCollectionInitPolicy.

onCacheResult

onCacheResult(handler): MessageCollectionInitHandler<Message>
Parameters
- handler: ((err: null | Error, messages: null | Message[]) => void)
  - - (err, messages): void
    - Parameters
      err: null | Error
      messages: null | Message[]
      Returns void
Returns MessageCollectionInitHandler<Message>
Description
This will give message lists loaded from the database. If the database is empty, this will give an empty list.