Interface ChatMessageStatusCallback

The message status change listener.

interface ChatMessageStatusCallback {
    onError(localMsgId: string, error: ChatError): void;
    onProgress?(localMsgId: string, progress: number): void;
    onSuccess(message: ChatMessage): void;
}

Index

Methods

onError onProgress? onSuccess

Methods

onError

onError(localMsgId: string, error: ChatError): void
Occurs when a message error occurs.
Parameters
- localMsgId: string
- error: ChatError
  A description of the error. See ChatError.
Returns void

`Optional`onProgress

onProgress?(localMsgId: string, progress: number): void
Occurs when a message is uploaded or downloaded.
Parameters
- localMsgId: string
- progress: number
  The message upload/download progress value. The value range is 0 to 100 in percentage.
Returns void

onSuccess

onSuccess(message: ChatMessage): void
Occurs when a message is successfully delivered.
Parameters
- message: ChatMessage
  The message that is successfully delivered.
Returns void