Class ImageMessageBody

Hierarchy (view full)

Constructors

constructor

Properties

hObject

Methods

getBigImageDownloadStatus getBigImageLocalPath getBigImageRemoteUrl getBody getDownloadStatus getFileLength getFileName getHeight getLocalPath getRemoteUrl getSecretKey getThumbnailDownloadStatus getThumbnailLocalPath getThumbnailRemoteUrl getWidth isGif isOriginalImage operationCount operationTime operatorId setBigImageLocalPath setDownloadStatus setFileLength setFileName setGif setLocalPath setRemoteUrl setSecretKey setSendOriginalImage setSize setThumbnailDownloadStatus setThumbnailLocalPath setThumbnailRemoteUrl setThumbnailSize toString type

Constructors

constructor

Properties

ProtectedhObject

hObject: EMMessageBody

Methods

getBigImageDownloadStatus

getBigImageLocalPath

  • getBigImageLocalPath(): string

  • 获取大图的本地路径。

    Returns string

    • 返回大图的本地路径。

getBigImageRemoteUrl

  • getBigImageRemoteUrl(): string

  • 获取大图的服务器地址。

    Returns string

    • 返回大图的服务器地址。

getBody

getDownloadStatus

getFileLength

getFileName

getHeight

  • getHeight(): number

  • 获取图片的高度。

    Returns number

    • 返回图片的高度。

getLocalPath

  • getLocalPath(): string

  • 获取文件本地绝对路径。

    Returns string

    • 返回文件的本地绝对路径。

getRemoteUrl

  • getRemoteUrl(): string

  • 获取文件的服务器路径。

    Returns string

    • 返回文件的服务器路径。

getSecretKey

  • getSecretKey(): string

  • 获取服务器生成的文件访问密钥。

    Returns string

    • 返回服务器生成的文件访问密钥。

getThumbnailDownloadStatus

getThumbnailLocalPath

  • getThumbnailLocalPath(): string

  • 获取缩略图的本地路径。

    Returns string

    • 返回缩略图的本地路径。

getThumbnailRemoteUrl

  • getThumbnailRemoteUrl(): string

  • 获取缩略图的服务器地址。

    Returns string

    • 返回缩略图的服务器地址。

getWidth

  • getWidth(): number

  • 获取图片的宽度。

    Returns number

    • 返回图片的宽度。

isGif

  • isGif(): boolean

  • 是否是gif类型图片。

    Returns boolean

    • 返回是否是gif类型图片。

isOriginalImage

  • isOriginalImage(): boolean

  • 是否发送原图。

    对于发送方：表示是否发送原图。 对于接收方：表示 getRemoteUrl 是否指向原图资源（而非发送方的压缩大图）。

    Returns boolean

    • true：原图；false：大图。

operationCount

operationTime

  • operationTime(): number

  • 获取最后一次消息修改的时间戳，单位为毫秒。

    Returns number

    • 返回消息最后一次修改的 UNIX 时间戳。

operatorId

  • operatorId(): string

  • 获取最后一次消息修改的操作者的用户 ID。

    Returns string

    • 返回最后一次消息修改的操作者的用户 ID。

setBigImageLocalPath

  • setBigImageLocalPath(bigImageLocalPath): void

  • 设置大图的本地路径。

    大图指发送图片时未发送原图（setSendOriginalImage 设为 false）所使用的压缩图， 压缩规则为最短边不超过 720px，质量压缩至 85%。

    Parameters

    • bigImageLocalPath: string

      大图的本地路径。

    Returns void

setDownloadStatus

setFileLength

  • setFileLength(fileLength): void

  • 设置文件大小，以字节为单位。

    Parameters

    • fileLength: number

      文件大小，以字节为单位。

    Returns void

setFileName

  • setFileName(fileName): void

  • 设置文件名。

    Parameters

    • fileName: string

      文件名。

    Returns void

setGif

  • setGif(isGif): void

  • 设置图片是否是Gif类型。

    Parameters

    • isGif: boolean

      true :是gif类型图片; false : 不是gif类型图片。

    Returns void

setLocalPath

  • setLocalPath(localPath): void

  • 设置文件本地绝对路径。

    Parameters

    • localPath: string

      文件本地绝对路径。

    Returns void

setRemoteUrl

  • setRemoteUrl(remotePath): void

  • 设置文件的服务器路径。

    Parameters

    • remotePath: string

      文件的服务器路径。

    Returns void

setSecretKey

  • setSecretKey(secretKey): void

  • 设置文件的访问密钥。

    Parameters

    • secretKey: string

      文件的访问密钥。

    Returns void

setSendOriginalImage

  • setSendOriginalImage(sendOriginalImage): void

  • 设置是否发送原图。

    设置为 true 时发送原图；设置为 false 时发送压缩后的大图（短边不超过 720px，质量压缩至 85%）。 需在发送消息前设置。

    Parameters

    • sendOriginalImage: boolean

      true：发送原图；false：发送大图。

    Returns void

setSize

  • setSize(width, height): void

  • 设置图片的尺寸。

    设置此参数后，接收方可以在下载附件前获取图片的尺寸。

    Parameters

    • width: number

      图片的宽度。

    • height: number

      图片的高度。

    Returns void

setThumbnailDownloadStatus

  • setThumbnailDownloadStatus(thumbnailDownloadStatus): void

  • 设置本地数据库缩略图的下载状态。

    Parameters

    Returns void

setThumbnailLocalPath

  • setThumbnailLocalPath(thumbnailLocalPath): void

  • 设置缩略图的本地路径。

    Parameters

    • thumbnailLocalPath: string

      缩略图的本地路径。

    Returns void

setThumbnailRemoteUrl

  • setThumbnailRemoteUrl(thumbnailRemotePath): void

  • 设置缩略图的服务器路径。

    Parameters

    • thumbnailRemotePath: string

      缩略图的服务器路径。

    Returns void

setThumbnailSize

  • setThumbnailSize(width, height): void

  • 设置缩略图的尺寸。

    图片消息发送到服务器后，服务器会根据此处设置的缩略图尺寸对原图进行压缩。

    如果没有设置，服务器会根据默认值进行压缩。

    Parameters

    • width: number

      指导服务器生成缩略图的宽度。

    • height: number

      指导服务器生成缩略图的高度。

    Returns void

    Remarks

    需要图片消息发送前设置。

toString

  • toString(isFull?): string

  • Returns a string representation of an object.

    Parameters

    • OptionalisFull: boolean

    Returns string

type

  • type(): number

  • 获取消息体类型。

    Returns number

    • 返回消息体类型。

Settings

Member Visibility

On This Page

Constructors
Properties
Methods