Interface ChatGroupFileStatusCallback

The status change listener for shared files in groups.

interface ChatGroupFileStatusCallback {
    onError(groupId: string, filePath: string, error: ChatError): void;
    onProgress?(groupId: string, filePath: string, progress: number): void;
    onSuccess(groupId: string, filePath: string): void;
}

Methods

onError onProgress? onSuccess

Methods

onError

  • onError(groupId, filePath, error): void

  • Occurs when there is an error during the upload or download of a shared file.

    Parameters

    • groupId: string

      The group ID.

    • filePath: string

      The path of the shared file.

    • error: ChatError

      A description of the error. See ChatError.

    Returns void

OptionalonProgress

  • onProgress(groupId, filePath, progress): void

  • Occurs when a shared file is being uploaded or downloaded.

    Parameters

    • groupId: string

      The group ID.

    • filePath: string

      The path of the shared file.

    • progress: number

      The value of the download or upload progress. The value range is 0-100 in percentage.

    Returns void

onSuccess

  • onSuccess(groupId, filePath): void

  • Occurs when the message is sent.

    Parameters

    • groupId: string

      The group ID.

    • filePath: string

      The path of the shared file.

    Returns void

Settings

Member Visibility

On This Page

Methods