leancloud-realtime

Members

(static) Message

Source:
See:

(static, constant) MessageStatus :Symbol

Source:
Since:
  • 3.2.0
Properties:
Name Type Description
NONE Symbol 初始状态、未知状态
SENDING Symbol 正在发送
SENT Symbol 已发送
DELIVERED Symbol 已送达
FAILED Symbol 发送失败
消息状态枚举
Type:
  • Symbol

(static) RecalledMessage

Source:
See:

(static) TextMessage

Source:
See:

(static) TypedMessage

Source:
See:

(inner, constant) MessagePriority :Number

Source:
Since:
  • 3.3.0
Properties:
Name Type Description
HIGH Number 高
NORMAL Number 普通
LOW Number 低
消息优先级枚举
Type:
  • Number

Methods

(static) messageField(fields)

Source:
decorator，定义消息类的自定义字段
Example
@messageField(['foo'])
class CustomMessage extends TypedMessage {
  constructor(foo) {
    super();
    this.foo = foo;
  }
}

// 不支持 decorator 的情况下可以这样使用
class CustomMessage extends TypedMessage {
  constructor(foo) {
    super();
    this.foo = foo;
  }
  //...
}
messageField(['foo'])(CustomMessage);
Parameters:
Name Type Description
fields Array.<String> 自定义字段

(static) messageType(type)

Source:
decorator，定义消息类的类型常量
Example
@messageType(1)
class CustomMessage extends TypedMessage {}

// 不支持 decorator 的情况下可以这样使用
class CustomMessage extends TypedMessage {
  //...
}
messageType(1)(CustomMessage);
Parameters:
Name Type Description
type Number 自定义类型请使用正整数

(inner) defineConversationProperty(prop, descriptoropt)

Source:
为 Conversation 定义一个新属性
Example
conversation.get('type');
conversation.set('type', 1);

// equals to
defineConversationProperty('type');
conversation.type;
conversation.type = 1;
Parameters:
Name Type Attributes Description
prop String 属性名
descriptor Object <optional>
 属性的描述符，参见 getOwnPropertyDescriptor#Description - MDN，默认为该属性名对应的 Conversation 自定义属性的 getter/setter
Returns:
void