Class ChatImageMessageBody

The image message body class.

Hierarchy

  • _ChatFileMessageBody
    • ChatImageMessageBody

Constructors

constructor

Properties

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

Constructors

constructor

  • new ChatImageMessageBody(params): ChatImageMessageBody

  • 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;
      }
      • displayName: string
      • OptionalfileSize?: number
      • OptionalfileStatus?: number
      • Optionalheight?: number
      • OptionallastModifyOperatorId?: string
      • OptionallastModifyTime?: number
      • localPath: string
      • OptionalmodifyCount?: number
      • OptionalremotePath?: string
      • Optionalsecret?: string
      • OptionalsendOriginalImage?: boolean
      • OptionalthumbnailLocalPath?: string
      • OptionalthumbnailRemotePath?: string
      • OptionalthumbnailSecret?: string
      • OptionalthumbnailStatus?: number
      • Optionalwidth?: number

    Returns ChatImageMessageBody

Properties

displayName

displayName: string

The file name.

fileSize

fileSize: number

The size of the file in bytes.

fileStatus

fileStatus: ChatDownloadStatus

The download status of the attachment file. See ChatDownloadStatus.

height

height: number

The image height in pixels.

OptionallastModifyOperatorId

lastModifyOperatorId?: string

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

OptionallastModifyTime

lastModifyTime?: number

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

localPath

localPath: string = ''

The local path of the file.

OptionalmodifyCount

modifyCount?: number

The number of times a message is modified.

remotePath

remotePath: string

The path of the attachment file in the server.

secret

secret: string

The token to download the file attachment.

sendOriginalImage

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

thumbnailLocalPath: string

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

thumbnailRemotePath

thumbnailRemotePath: string

The URL of the thumbnail on the server.

thumbnailSecret

thumbnailSecret: string

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

thumbnailStatus

thumbnailStatus: ChatDownloadStatus

The download status of the thumbnail. See ChatDownloadStatus

Readonlytype

type: ChatMessageType

The message type. See ChatMessageType.

width

width: number

The image width in pixels.

Settings

Member Visibility

On This Page

Constructors
Properties