AVMessage

消息接口,所有通过 Realtime#register 注册的消息类需要实现该接口

Members

static sendOptions

消息的默认发送选项,指定该属性后发送该类型的消息时会将其作为默认的发送选项。比如可以用来指定某种类型的消息默认优先级为高。
Since:
  • 3.3.0
See:

Methods

static parse(json, message) → {AVMessage}

解析处理消息内容 (JSON -> AVMessage)

如果子类没有提供 message,直接使用该 message, 如果没有提供,实例化一个当前类型的 message, 将 JSON 格式的消息内容中相关的信息设置给该消息, 然后将其传递给父类的 parse 方法 (当然,你也可以不管父类直接返回 message)。

Parameters:
Name Type Description
json Object JSON 格式的消息内容
message AVMessage 子类提供的消息实例
Returns:
AVMessage

static validate(json) → {Boolean}

判断给定的内容是否是该类型的 Message
Parameters:
Name Type Description
json Object JSON 格式的消息内容
Returns:
Boolean

getPayload() → {Object}

获取当前消息的内容,与 parse 相对 (AVMessage -> JSON)

在这个方法中,应该先调用父类的 getPayload 方法,得到 JSON 对象, 然后,将当前消息实例的信息修改 JSON 对象后返回 (当然,你也可以不管父类返回的 JSON)。

Returns:
Object - JSON 格式的消息内容