Chat SDK v1.3.5 for React Native
    Preparing search index...

    Class ChatImageMessageBody

    The image message body class.

    Hierarchy

    • _ChatFileMessageBody
      • ChatImageMessageBody
    Index

    Constructors

    constructor

    Properties

    displayName fileSize fileStatus height lastModifyOperatorId? lastModifyTime? localPath modifyCount? remotePath secret sendOriginalImage thumbnailLocalPath thumbnailRemotePath thumbnailSecret thumbnailStatus type width

    Constructors

    • Parameters

      • params: {
            displayName: string;
            fileSize?: number;
            fileStatus?: number;
            height?: number;
            lastModifyOperatorId?: string;
            lastModifyTime?: number;
            localPath: string;
            modifyCount?: number;
            remotePath?: string;
            secret?: string;
            sendOriginalImage?: boolean;
            thumbnailLocalPath?: string;
            thumbnailRemotePath?: string;
            thumbnailSecret?: string;
            thumbnailStatus?: number;
            width?: number;
        }

      Returns ChatImageMessageBody

    Properties

    displayName: string

    The file name.

    fileSize: number

    The size of the file in bytes.

    fileStatus: ChatDownloadStatus

    The download status of the attachment file. See ChatDownloadStatus.

    height: number

    The image height in pixels.

    lastModifyOperatorId?: string

    The user ID of the operator that modified the message last time.

    lastModifyTime?: number

    The UNIX timestamp of the last message modification, in milliseconds.

    localPath: string = ''

    The local path of the file.

    modifyCount?: number

    The number of times a message is modified.

    remotePath: string

    The path of the attachment file in the server.

    secret: string

    The token to download the file attachment.

    sendOriginalImage: boolean

    Whether to send the original image.

      • true: Yes.
      • (Default) false: No. If the image is smaller than 100 KB, the SDK sends the original image. If the image is equal to or greater than 100 KB, the SDK will compress it before sending the compressed image.
    thumbnailLocalPath: string

    The local path or the URI of the thumbnail as a string.

    thumbnailRemotePath: string

    The URL of the thumbnail on the server.

    thumbnailSecret: string

    The secret to access the thumbnail. A secret is required for verification for thumbnail download.

    thumbnailStatus: ChatDownloadStatus

    The download status of the thumbnail. See ChatDownloadStatus

    type: ChatMessageType

    The message type. See ChatMessageType.

    width: number

    The image width in pixels.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties