Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatImageMessageBody

export class type

Hierarchy

  • _ChatFileMessageBody
    • ChatImageMessageBody

Index

Constructors

Properties

Constructors

constructor

  • new ChatImageMessageBody(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 }): 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
      • Optional fileSize?: number
      • Optional fileStatus?: number
      • Optional height?: number
      • Optional lastModifyOperatorId?: string
      • Optional lastModifyTime?: number
      • localPath: string
      • Optional modifyCount?: number
      • Optional remotePath?: string
      • Optional secret?: string
      • Optional sendOriginalImage?: boolean
      • Optional thumbnailLocalPath?: string
      • Optional thumbnailRemotePath?: string
      • Optional thumbnailSecret?: string
      • Optional thumbnailStatus?: number
      • Optional width?: 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.

Optional lastModifyOperatorId

lastModifyOperatorId?: string

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

Optional lastModifyTime

lastModifyTime?: number

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

localPath

localPath: string = ''

The local path of the file.

Optional modifyCount

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

Readonly type

type: ChatMessageType

The message type. See ChatMessageType.

width

width: number

The image width in pixels.

Generated using TypeDoc