Skip to content

Models_zh.md

Latest commit

 

History

History
112 lines (89 loc) · 2.2 KB

Models_zh.md

File metadata and controls

112 lines (89 loc) · 2.2 KB

English Document

Contents

UserInfo

fromUser = {
  userId: ""
  displayName: ""
  avatarPath: "avatar image path"
}

Message

status 必须为以下四个值之一: "send_succeed", "send_failed", "send_going", "download_failed"，如果没有定义这个属性， 默认值是 "send_succeed".

TextMessage

  textMessage = {
    msgId: "msgid",
    status: "send_going",
    msgType: "text",
    isOutgoing: true,
    text: "text",
    fromUser: {},
    extras: {}// 选填，可以在消息中添加附加字段
}

ImageMessage

imageMessage = {
    msgId: "msgid",
    msgType: "image",
    isOutGoing: true,
    mediaPath: "image path",
    fromUser: {}，
    extras: {}// 选填，可以在消息中添加附加字段
}

VoiceMessage

message = {
    msgId: "msgid",
    msgType: "voice",
    isOutGoing: true,
    duration: number, // 注意这个值有用户自己设置时长，单位秒
    mediaPath: "voice path",
    fromUser: {},
    extras: {}// 选填，可以在消息中添加附加字段
}

VideoMessage

videoMessage = {  // video message
    msgId: "msgid",
    status: "send_failed",
    msgType: "video",
    isOutGoing: true,
    druation: number,
    mediaPath: "voice path",
    fromUser: {},
    extras: {}// 选填，可以在消息中添加附加字段
}s

CustomMessage

customMessage = {  // custom message
    msgId: "msgid",
    msgType: "custom",
    status: "send_failed",
    isOutgoing: true,
    contentSize: {height: 100, width: 100},
    content: "<h1>custom message will render html string</h1>", // content 为 html 字符串，应尽量避免 <script> 标签
    fromUser: {}, 
    extras: {}// 选填，可以在消息中添加附加字段
}

EventMessage

eventMessage = {  // event message
    msgId: "msgid",
    msgType: "event",
    text: "the event text"
}