Class ImageMessage

图片消息

Version

1.0.0

Hierarchy (view full)

Constructors

constructor

Properties

name localPath remoteUrl extra? userInfo? mentionedInfo? rawString? thumbnailBase64 isFull

Methods

getCorrectedLocalPath getSearchableWord encodeBaseData decodeBaseData encode decode getClassName

Constructors

constructor

Properties

name

name: string = ""

媒体资源的名称

localPath

localPath: string = ""

媒体资源的本地路径

remoteUrl

remoteUrl: string = ""

媒体资源的远端地址

Optionalextra

extra?: string

消息的附加信息，会随着消息发送出去

OptionaluserInfo

userInfo?: UserInfo

消息携带的用户信息

OptionalmentionedInfo

mentionedInfo?: MentionedInfo

消息的 @ 信息

OptionalrawString

rawString?: string

消息的原始内容

SDK 执行消息的 decode 方法正常时，会将数据解析到消息的各个字段，rawString 将会为空

如果 decode 方法异常时会将消息的原始数据保存在 rawString 中

thumbnailBase64

thumbnailBase64: string = ""

缩略图 base64

isFull

isFull: boolean = false

是否是原图

Methods

getCorrectedLocalPath

  • getCorrectedLocalPath(localPath): string

  • 获取正常的 localPath ，去掉 file://

    在鸿蒙系统内部，沙盒路径需要用 file:// 开头才能被 fs 识别

    原生层使用不能以 file:// 开头

    Parameters

    • localPath: string

    Returns string

getSearchableWord

  • getSearchableWord(): any

  • 返回消息体内的可搜索内容

    如果消息包含多个字段,可将每个字段填充到 List 中; 比如图文消息的 title 和 summary。

    SDK 内置消息已支持搜索，自定义消息需要实现该方法
    1) 不实现该方法，该类消息无法被搜索
    2) 实现该方法，返回 null 或者 List 长度为 0，无法被搜索
    3) 实现该方法， List 里面的 空字符串 和 null 会被忽略
    4) List 中必须包含有效的字符串才能被搜索到

    Returns any

    可搜索的内容

    Version

    1.1.0

encodeBaseData

  • encodeBaseData(): HashMap<string, Object>

  • 将基类的基础数据保存到 map 中

    Returns HashMap<string, Object>

decodeBaseData

  • decodeBaseData(map): void

  • 将基类的基础数据从 map 中解析出来

    Parameters

    • map: HashMap<string, Object>

    Returns void

encode

  • encode(): string

  • 编码方法，将消息转为 json 字符串

    Returns string

    json 字符串

decode

  • decode(contentString): void

  • 解码方法，将 json 字符串转为消息

    Parameters

    • contentString: string

      json 字符串

    Returns void

getClassName

Settings

Member Visibility

On This Page

Constructors
Properties
Methods