@cg-devcenter/rtc-fpnn-webjs-sdk 1.0.0-cg.5 → 1.0.0-cg.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,126 @@
1
+ # RTM Client Websocket SDK Event Process API Docs
2
+
3
+ ## Index
4
+
5
+ [TOC]
6
+
7
+ ## Apis
8
+
9
+ **协议范围:** 本页记录 FPNN 兼容 API 的参数和事件名称;列出的方法不一定都能通过 TLV v1 调用。请先核对 [TLV v1 支持矩阵](USAGE.md#6-tlv-v1-api-支持矩阵);两协议的 method、URI 和 Push 对照见[协议迁移说明](PROTOCOL_MIGRATION.md)。
10
+
11
+ 请参考 `RTMConfig.SERVER_PUSH` 成员
12
+
13
+ > TLV v1 模式说明:网络 Push wire 为 `event.direct`、`event.group`、`event.room`、`event.broadcast`、`event.kicked`、`event.room_removed`,请通过 `RTMConfig.TLV_SERVER_PUSH` 订阅同名事件;data 使用新字段(例如 `message_ref`、`time_ms`、`payload`)。前四类会在回调前自动发送 `control.ack`,后两类不会 ACK。TLV 业务心跳改为 Client 主动 `control.ping`,不再依赖本页的服务端 `ping` Push。
14
+
15
+ * `kickout`: RTMGate主动断开
16
+ * `data`: **(object)**
17
+
18
+ * `kickoutroom`: RTMGate主动从Room移除
19
+ * `data.rid`: **(Int64)** Room id
20
+
21
+ * `ping`: RTMGate主动ping
22
+ * `data`: **(object)**
23
+
24
+ * `pushmsg`: RTMGate主动推送P2P消息
25
+ * `data.from`: **(Int64)** 发送者 id
26
+ * `data.mtype`: **(number)** 消息类型
27
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
28
+ * `data.msg`: **(string)** 消息内容
29
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
30
+ * `data.mtime`: **(Int64)**
31
+
32
+ * `pushgroupmsg`: RTMGate主动推送Group消息
33
+ * `data.from`: **(Int64)** 发送者 id
34
+ * `data.gid`: **(Int64)** Group id
35
+ * `data.mtype`: **(number)** 消息类型
36
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
37
+ * `data.msg`: **(string)** 消息内容
38
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
39
+ * `data.mtime`: **(Int64)**
40
+
41
+ * `pushroommsg`: RTMGate主动推送Room消息
42
+ * `data.from`: **(Int64)** 发送者 id
43
+ * `data.rid`: **(Int64)** Room id
44
+ * `data.mtype`: **(number)** 消息类型
45
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
46
+ * `data.msg`: **(string)** 消息内容
47
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
48
+ * `data.mtime`: **(Int64)**
49
+
50
+ * `pushbroadcastmsg`: RTMGate主动推送广播消息
51
+ * `data.from`: **(Int64)** 发送者 id
52
+ * `data.mtype`: **(number)** 消息类型
53
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
54
+ * `data.msg`: **(string)** 消息内容
55
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
56
+ * `data.mtime`: **(Int64)**
57
+
58
+ * `pushfile`: RTMGate主动推送P2P文件
59
+ * `data.from`: **(Int64)** 发送者 id
60
+ * `data.mtype`: **(number)** 文件类型, 请参考 `RTMConfig.FILE_TYPE` 成员
61
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
62
+ * `data.msg`: **(string)** 文件获取地址(url)
63
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
64
+ * `data.mtime`: **(Int64)**
65
+
66
+ * `pushgroupfile`: RTMGate主动推送Group文件
67
+ * `data.from`: **(Int64)** 发送者 id
68
+ * `data.gid`: **(Int64)** Group id
69
+ * `data.mtype`: **(number)** 文件类型, 请参考 `RTMConfig.FILE_TYPE` 成员
70
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
71
+ * `data.msg`: **(string)** 文件获取地址(url)
72
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
73
+ * `data.mtime`: **(Int64)**
74
+
75
+ * `pushroomfile`: RTMGate主动推送Room文件
76
+ * `data.from`: **(Int64)** 发送者 id
77
+ * `data.rid`: **(Int64)** Room id
78
+ * `data.mtype`: **(number)** 文件类型, 请参考 `RTMConfig.FILE_TYPE` 成员
79
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
80
+ * `data.msg`: **(string)** 文件获取地址(url)
81
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
82
+ * `data.mtime`: **(Int64)**
83
+
84
+ * `pushbroadcastfile`: RTMGate主动推送广播文件
85
+ * `data.from`: **(Int64)** 发送者 id
86
+ * `data.mtype`: **(number)** 文件类型, 请参考 `RTMConfig.FILE_TYPE` 成员
87
+ * `data.mid`: **(Int64)** 消息 id, 当前链接会话内唯一
88
+ * `data.msg`: **(string)** 文件获取地址(url)
89
+ * `data.attrs`: **(string)** 发送时附加的自定义内容
90
+ * `data.mtime`: **(Int64)**
91
+
92
+ * `pushchat`: RTMGate主动推送聊天消息
93
+ * 参数与pushmsg一致
94
+
95
+ * `pushaudio`: RTMGate主动推送语音聊天消息
96
+ * 参数与pushmsg一致
97
+
98
+ * `pushcmd`: RTMGate主动推送聊天控制命令
99
+ * 参数与pushmsg一致
100
+
101
+ * `pushgroupchat`: RTMGate主动推送组聊天消息
102
+ * 参数与pushgroupmsg一致
103
+
104
+ * `pushgroupaudio`: RTMGate主动推送组语音消息
105
+ * 参数与pushgroupmsg一致
106
+
107
+ * `pushgroupcmd`: RTMGate主动推送组聊天控制命令
108
+ * 参数与pushgroupmsg一致
109
+
110
+ * `pushroomchat`: RTMGate主动推送房间聊天消息
111
+ * 参数与pushroommsg一致
112
+
113
+ * `pushroomaudio`: RTMGate主动推送房间语音消息
114
+ * 参数与pushroommsg一致
115
+
116
+ * `pushroomcmd`: RTMGate主动推送房间聊天控制命令
117
+ * 参数与pushroommsg一致
118
+
119
+ * `pushbroadcastchat`: RTMGate主动推送广播聊天消息
120
+ * 参数与pushbroadcastchat一致
121
+
122
+ * `pushbroadcastaudio`: RTMGate主动推送广播语音消息
123
+ * 参数与pushbroadcastchat一致
124
+
125
+ * `pushbroadcastcmd`: RTMGate主动推送广播聊天控制命令
126
+ * 参数与pushbroadcastchat一致
package/docs/Files.md ADDED
@@ -0,0 +1,52 @@
1
+ # RTM Client Websocket SDK File API Docs
2
+
3
+ ## Index
4
+
5
+ [TOC]
6
+
7
+ ## Apis
8
+
9
+ FPNN 模式下,以下 API 同时适用于独立 `RTMClient` 和共享客户端(`createClient()` / `RTMSharedWorkerClient`),callback 与 Promise 结果沿用 SDK 约定。SharedWorker 通过结构化克隆接收 `File`,由内部 SDK 获取 token 并建立文件代理连接上传。现有上传会读取整个文件到内存;不承诺所有页面关闭或 Worker 被回收后仍能完成后台上传。TLV v1 的文件接口仍由底层协议契约拒绝。
10
+
11
+ * `fileToken(cmd, tos, to, rid, gid, timeout, callback)`: 获取发送文件的token
12
+ * `cmd`: **(Required | string)** 文件发送方式`sendfile | sendroomfile | sendgroupfile`
13
+ * `tos`: **(Optional | array[Int64])** 接收方 uids
14
+ * `to`: **(Optional | Int64)** 接收方 uid
15
+ * `rid`: **(Optional | Int64)** Room id
16
+ * `gid`: **(Optional | Int64)** Group id
17
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
18
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
19
+ * `err`: **(Error)**
20
+ * `data`: **(object[token:string, endpoint:string])**
21
+
22
+ * `sendFile(mtype, to, file, mid, timeout, callback)`: 发送文件
23
+ * `mtype`: **(Required | number)** 文件类型
24
+ * `to`: **(Required | Int64)** 接收者 id
25
+ * `file`: **(Required | File)** 要发送的文件
26
+ * `mid`: **(Optional | Int64)** 消息 id, 用于过滤重复消息, 非重发时为`Int64(0)`
27
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
28
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
29
+ * `err`: **(object[mid:Int64, error:Error])**
30
+ * `data`: **(object[mid:Int64, payload:object[mtime:Int64]])**
31
+
32
+ * `sendGroupFile(mtype, gid, file, mid, timeout, callback)`: 给Group发送文件
33
+ * `mtype`: **(Required | number)** 文件类型
34
+ * `gid`: **(Required | Int64)** Group id
35
+ * `file`: **(Required | File)** 要发送的文件
36
+ * `mid`: **(Optional | Int64)** 消息 id, 用于过滤重复消息, 非重发时为`Int64(0)`
37
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
38
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
39
+ * `err`: **(object[mid:Int64, error:Error])**
40
+ * `data`: **(object[mid:Int64, payload:object[mtime:Int64]])**
41
+
42
+ * `sendRoomFile(mtype, rid, file, mid, timeout, callback)`: 给Room发送文件
43
+ * `mtype`: **(Required | number)** 文件类型
44
+ * `rid`: **(Required | Int64)** Room id
45
+ * `file`: **(Required | File)** 要发送的文件
46
+ * `mid`: **(Optional | Int64)** 消息 id, 用于过滤重复消息, 非重发时为`Int64(0)`
47
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
48
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
49
+ * `err`: **(object[mid:Int64, error:Error])**
50
+ * `data`: **(object[mid:Int64, payload:object[mtime:Int64]])**
51
+
52
+
@@ -0,0 +1,50 @@
1
+ # RTM Client Websocket SDK Friends API Docs
2
+
3
+ ## Index
4
+
5
+ [TOC]
6
+
7
+ ## Apis
8
+
9
+ **协议范围:** 本页记录 FPNN 兼容 API 的参数和事件名称;列出的方法不一定都能通过 TLV v1 调用。请先核对 [TLV v1 支持矩阵](USAGE.md#6-tlv-v1-api-支持矩阵);两协议的 method、URI 和 Push 对照见[协议迁移说明](PROTOCOL_MIGRATION.md)。
10
+
11
+ * `addFriends(friends, timeout, callback)`: 添加好友
12
+ * `friends`: **(Required | array[Int64])** 多个好友 id
13
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
14
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
15
+ * `err`: **(Error)**
16
+ * `data`: **(object)**
17
+
18
+ * `deleteFriends(friends, timeout, callback)`: 删除好友
19
+ * `friends`: **(Required | array[Int64])** 多个好友 id
20
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
21
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
22
+ * `err`: **(Error)**
23
+ * `data`: **(object)**
24
+
25
+ * `getFriends(timeout, callback)`: 获取好友
26
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
27
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
28
+ * `err`: **(Error)**
29
+ * `data`: **(array[Int64])**
30
+
31
+ * `addBlacks(blacks, timeout, callback)`: 添加黑名单,每次最多添加100人,拉黑后对方不能给自己发消息,自己可以给对方发,双方能正常获取session及历史消息
32
+ * `blacks`: **(Required | array[Int64])** 多个用户id
33
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
34
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
35
+ * `err`: **(Error)**
36
+ * `data`: **(object)**
37
+
38
+ * `deleteBlacks(blacks, timeout, callback)`: 解除拉黑,每次最多解除100人
39
+ * `friends`: **(Required | array[Int64])** 多个用户id
40
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
41
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
42
+ * `err`: **(Error)**
43
+ * `data`: **(object)**
44
+
45
+ * `getBlacks(timeout, callback)`: 获取被我拉黑的用户列表
46
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
47
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
48
+ * `err`: **(Error)**
49
+ * `data`: **(array[Int64])**
50
+
package/docs/Groups.md ADDED
@@ -0,0 +1,64 @@
1
+ # RTM Client Websocket SDK Group API Docs
2
+
3
+ ## Index
4
+
5
+ [TOC]
6
+
7
+ ## Apis
8
+
9
+ **协议范围:** 本页记录 FPNN 兼容 API 的参数和事件名称;列出的方法不一定都能通过 TLV v1 调用。请先核对 [TLV v1 支持矩阵](USAGE.md#6-tlv-v1-api-支持矩阵);两协议的 method、URI 和 Push 对照见[协议迁移说明](PROTOCOL_MIGRATION.md)。
10
+
11
+ * `setGroupInfo(gid, oinfo, pinfo, timeout, callback) `: 设置组信息
12
+ * `gid`: **(Required | Int64)** 组id
13
+ * `oinfo`: **(Optional | string)** 公开信息
14
+ * `pinfo`: **(Optional | string)** 私有信息
15
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
16
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
17
+ * `err`: **(object[mid:Int64, error:Error])**
18
+ * `data`: **(object)**
19
+
20
+ * `getGroupInfo(gid, timeout, callback) `: 获取群组的公开信息和私有信息,会检查用户是否在组内
21
+ * `gid`: **(Required | Int64)** 组id
22
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
23
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
24
+ * `err`: **(object[mid:Int64, error:Error])**
25
+ * `data`: **(object[oinfo:string, pinfo:string])**
26
+
27
+ * `getGroupOpenInfo(gid, timeout, callback) `: 获取群组的公开信息
28
+ * `gid`: **(Required | Int64)** 组id
29
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
30
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
31
+ * `err`: **(object[mid:Int64, error:Error])**
32
+ * `data`: **(object[oinfo:string, pinfo:string])**
33
+
34
+ * `addGroupMembers(gid, uids, timeout, callback)`: 添加group成员
35
+ * `gid`: **(Required | Int64)** group id
36
+ * `uids`: **(Required | array[Int64])** 多个用户 id
37
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
38
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
39
+ * `err`: **(Error)**
40
+ * `data`: **(object)**
41
+
42
+ * `deleteGroupMembers(gid, uids, timeout, callback)`: 删除group成员
43
+ * `gid`: **(Required | Int64)** group id
44
+ * `uids`: **(Required | array[Int64])** 多个用户 id
45
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
46
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
47
+ * `err`: **(Error)**
48
+ * `data`: **(object)**
49
+
50
+ * `getGroupMembers(gid, online, timeout, callback)`: 获取group成员
51
+ * `gid`: **(Required | Int64)** group id
52
+ * `online`: **(Optional | Bool)** get online users
53
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
54
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
55
+ * `err`: **(Error)**
56
+ * `data`: **(array[Int64])**
57
+
58
+ * `getGroupCount(gid, online, timeout, callback)`: 获取group成员
59
+ * `gid`: **(Required | Int64)** group id
60
+ * `online`: **(Optional | Bool)** get online users count
61
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
62
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
63
+ * `err`: **(Error)**
64
+ * `data`: **(array[Int64])**
@@ -0,0 +1,183 @@
1
+ # RTM Client Websocket SDK Message API Docs
2
+
3
+ ## Index
4
+
5
+ [TOC]
6
+
7
+ ## Apis
8
+
9
+ **协议范围:** 本页记录 FPNN 兼容 API 的参数和事件名称;列出的方法不一定都能通过 TLV v1 调用。请先核对 [TLV v1 支持矩阵](USAGE.md#6-tlv-v1-api-支持矩阵);两协议的 method、URI 和 Push 对照见[协议迁移说明](PROTOCOL_MIGRATION.md)。
10
+
11
+ * `sendMessage(to, mtype, msg, attrs, mid, timeout, callback)`: 发送消息
12
+ * `to`: **(Required | Int64)** 接收方uid
13
+ * `mtype`: **(Required | number)** 消息类型
14
+ * `msg`: **(Required | string)** 消息内容
15
+ * `attrs`: **(Required | string)** 消息附加信息, 没有可传`''`
16
+ * `mid`: **(Optional | Int64)** 消息 id, 用于过滤重复消息, 非重发时为`Int64(0)`
17
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
18
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
19
+ * `err`: **(object[mid:Int64, error:Error])**
20
+ * `data`: **(object[mid:Int64, payload:object[mtime:Int64]])**
21
+
22
+ * `sendGroupMessage(gid, mtype, msg, attrs, mid, timeout, callback)`: 发送group消息
23
+ * `gid`: **(Required | Int64)** group id
24
+ * `mtype`: **(Required | number)** 消息类型
25
+ * `msg`: **(Required | string)** 消息内容
26
+ * `attrs`: **(Required | string)** 消息附加信息, 可传`''`
27
+ * `mid`: **(Optional | Int64)** 消息 id, 用于过滤重复消息, 非重发时为`Int64(0)`
28
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
29
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
30
+ * `err`: **(object[mid:Int64, error:Error])**
31
+ * `data`: **(object[mid:Int64, payload:object[mtime:Int64]])**
32
+
33
+ * `sendRoomMessage(rid, mtype, msg, attrs, mid, timeout, callback)`: 发送room消息
34
+ * `rid`: **(Required | Int64)** room id
35
+ * `mtype`: **(Required | number)** 消息类型
36
+ * `msg`: **(Required | string)** 消息内容
37
+ * `attrs`: **(Required | string)** 消息附加信息, 可传`''`
38
+ * `mid`: **(Optional | Int64)** 消息 id, 用于过滤重复消息, 非重发时为`Int64(0)`
39
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
40
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
41
+ * `err`: **(object[mid:Int64, error:Error])**
42
+ * `data`: **(object[mid:Int64, payload:object[mtime:Int64]])**
43
+
44
+
45
+
46
+ * `getUnreadMessage(clear, withLogout, timeout, callback)`: 检测未读消息数目;旧调用 `getUnreadMessage(clear, timeout, callback)` 仍兼容。
47
+ * `clear`: **(Optional | bool)** 是否除离线提醒
48
+ * `withLogout`: **(Optional | bool)** 是否返回登出时间
49
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
50
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
51
+ * `err`: **(Error)**
52
+ * `data`: **(object[p2p:array(Int64), group:array(Int64)])** 对应值为未读消息数目
53
+
54
+ * `cleanUnreadMessage(timeout, callback)`: 清除未读消息
55
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
56
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
57
+ * `err`: **(Error)**
58
+ * `data`: **(object)**
59
+
60
+ * `getP2PUnreadMessageNum(uids, mtime, mtypes, timeout, callback)`: 获取未读P2P消息数目
61
+ * `uids`: **(Required | [int64])** uid列表
62
+ * `mtime`: **(Required | int64)** 毫秒级时间戳,获取这个时间戳之后的未读消息,如果mtime 为空,则获取上一次logout后的未读消息
63
+ * `mtypes`: **(Required | [number])** 获取指定mtype的未读消息,为空或undefined,则获取聊天相关未读消息
64
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
65
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
66
+ * `err`: **(Error)**
67
+ * `data`:
68
+ * `p2p` : **({ uid => num})**
69
+ * `ltime` : **({ session_id => time})** 每个session的的最新一条消息时间
70
+
71
+ * `getGroupUnreadMessageNum(gids, mtime, mtypes, timeout, callback)`: 获取未读Group消息数目
72
+ * `gids`: **(Required | [int64])** gid列表
73
+ * `mtime`: **(Required | int64)** 毫秒级时间戳,获取这个时间戳之后的未读消息,如果mtime 为空,则获取上一次logout后的未读消息
74
+ * `mtypes`: **(Required | [number])** 获取指定mtype的未读消息,为空或undefined,则获取聊天相关未读消息
75
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
76
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
77
+ * `err`: **(Error)**
78
+ * `data`:
79
+ * `group` : **({ gid => num})**
80
+ * `ltime` : **({ session_id => time})** 每个session的的最新一条消息时间
81
+
82
+ * `getGroupMessage(gid, desc, num, begin, end, lastid, mtypes, timeout, callback)`: 获取Group历史消息
83
+ * `gid`: **(Required | Int64)** Group id
84
+ * `desc`: **(Required | bool)** `true`: 则从`end`的时间戳开始倒序翻页, `false`: 则从`begin`的时间戳顺序翻页
85
+ * `num`: **(Required | number)** 获取数量, **一次最多获取20条, 建议10条**
86
+ * `begin`: **(Optional | Int64)** 开始时间戳, 毫秒, 默认`0`, 条件:`>=`
87
+ * `end`: **(Optional | Int64)** 结束时间戳, 毫秒, 默认`0`, 条件:`<=`
88
+ * `lastid`: **(Optional | Int64)** 最后一条消息的id, 第一次默认传`0`, 条件:`> or <`
89
+ * `mtypes`: **(Optional | array(number))** 获取哪些mtype的历史
90
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
91
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
92
+ * `err`: **(Error)**
93
+ * `data`: **(object[num:number, lastid:Int64, begin:Int64, end:Int64, msgs:array[GroupMsg]])**
94
+ * `GroupMsg.id` **(Int64)**
95
+ * `GroupMsg.from` **(Int64)**
96
+ * `GroupMsg.mtype` **(number)**
97
+ * `GroupMsg.mid` **(Int64)**
98
+ * `GroupMsg.deleted` **(bool)**
99
+ * `GroupMsg.msg` **(string)**
100
+ * `GroupMsg.attrs` **(string)**
101
+ * `GroupMsg.mtime` **(Int64)**
102
+
103
+ * `getRoomMessage(rid, desc, num, begin, end, lastid, mtypes, timeout, callback)`: 获取Room历史消息
104
+ * `rid`: **(Required | Int64)** Room id
105
+ * `desc`: **(Required | bool)** `true`: 则从`end`的时间戳开始倒序翻页, `false`: 则从`begin`的时间戳顺序翻页
106
+ * `num`: **(Required | number)** 获取数量, **一次最多获取20条, 建议10条**
107
+ * `begin`: **(Optional | Int64)** 开始时间戳, 毫秒, 默认`0`, 条件:`>=`
108
+ * `end`: **(Optional | Int64)** 结束时间戳, 毫秒, 默认`0`, 条件:`<=`
109
+ * `lastid`: **(Optional | Int64)** 最后一条消息的id, 第一次默认传`0`, 条件:`> or <`
110
+ * `mtypes`: **(Optional | array(number))** 获取哪些mtype的历史
111
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
112
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
113
+ * `err`: **(Error)**
114
+ * `data`: **(object[num:number, lastid:Int64, begin:Int64, end:Int64, msgs:array[RoomMsg]])**
115
+ * `RoomMsg.id` **(Int64)**
116
+ * `RoomMsg.from` **(Int64)**
117
+ * `RoomMsg.mtype` **(number)**
118
+ * `RoomMsg.mid` **(Int64)**
119
+ * `RoomMsg.deleted` **(bool)**
120
+ * `RoomMsg.msg` **(string)**
121
+ * `RoomMsg.attrs` **(string)**
122
+ * `RoomMsg.mtime` **(Int64)**
123
+
124
+ * `getBroadcastMessage(desc, num, begin, end, lastid, mtypes, timeout, callback)`: 获取广播历史消息
125
+ * `desc`: **(Required | bool)** `true`: 则从`end`的时间戳开始倒序翻页, `false`: 则从`begin`的时间戳顺序翻页
126
+ * `num`: **(Required | number)** 获取数量, **一次最多获取20条, 建议10条**
127
+ * `begin`: **(Optional | Int64)** 开始时间戳, 毫秒, 默认`0`, 条件:`>=`
128
+ * `end`: **(Optional | Int64)** 结束时间戳, 毫秒, 默认`0`, 条件:`<=`
129
+ * `lastid`: **(Optional | Int64)** 最后一条消息的id, 第一次默认传`0`, 条件:`> or <`
130
+ * `mtypes`: **(Optional | array(number))** 获取哪些mtype的历史
131
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
132
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
133
+ * `err`: **(Error)**
134
+ * `data`: **(object[num:number, lastid:Int64, begin:Int64, end:Int64, msgs:array[BroadcastMsg]])**
135
+ * `BroadcastMsg.id` **(Int64)**
136
+ * `BroadcastMsg.from` **(Int64)**
137
+ * `BroadcastMsg.mtype` **(number)**
138
+ * `BroadcastMsg.mid` **(Int64)**
139
+ * `BroadcastMsg.deleted` **(bool)**
140
+ * `BroadcastMsg.msg` **(string)**
141
+ * `BroadcastMsg.attrs` **(string)**
142
+ * `BroadcastMsg.mtime` **(Int64)**
143
+
144
+ * `getP2PMessage(ouid, desc, num, begin, end, lastid, mtypes, timeout, callback)`: 获取P2P历史消息
145
+ * `ouid`: **(Required | Int64)** 获取和哪个用户id的历史消息
146
+ * `desc`: **(Required | bool)** `true`: 则从`end`的时间戳开始倒序翻页, `false`: 则从`begin`的时间戳顺序翻页
147
+ * `num`: **(Required | number)** 获取数量, **一次最多获取20条, 建议10条**
148
+ * `begin`: **(Optional | Int64)** 开始时间戳, 毫秒, 默认`0`, 条件:`>=`
149
+ * `end`: **(Optional | Int64)** 结束时间戳, 毫秒, 默认`0`, 条件:`<=`
150
+ * `lastid`: **(Optional | Int64)** 最后一条消息的id, 第一次默认传`0`, 条件:`> or <`
151
+ * `mtypes`: **(Optional | array(number))** 获取哪些mtype的历史
152
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
153
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
154
+ * `err`: **(Error)**
155
+ * `data`: **(object[num:number, lastid:Int64, begin:Int64, end:Int64, msgs:array[P2PMsg]])**
156
+ * `P2PMsg.id` **(Int64)**
157
+ * `P2PMsg.direction` **(number)**
158
+ * `P2PMsg.mtype` **(number)**
159
+ * `P2PMsg.mid` **(Int64)**
160
+ * `P2PMsg.deleted` **(bool)**
161
+ * `P2PMsg.msg` **(string)**
162
+ * `P2PMsg.attrs` **(string)**
163
+ * `P2PMsg.mtime` **(Int64)**
164
+
165
+ * `getMessage(frrom, mid, xid, type, timeout, callback)`: 获取消息
166
+ * `from`: **(Required | Int64)** 发送者用户 id
167
+ * `mid`: **(Required | Int64)** 消息 id
168
+ * `xid`: **(Required | Int64)** 消息接收方 id (userId/RoomId/GroupId)
169
+ * `type`: **(Required | number)** 接收方类型 (1:p2p, 2:group, 3:room)
170
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
171
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
172
+ * `err`: **(Error)**
173
+ * `data`: **(object[id: Int64, mtype: number, msg: string, attrs: string, mtime: Int64])**
174
+
175
+ * `deleteMessage(from, mid, xid, type, timeout, callback)`: 删除消息
176
+ * `from`: **(Required | Int64)** 发送者用户 id
177
+ * `mid`: **(Required | Int64)** 消息 id
178
+ * `xid`: **(Required | Int64)** 消息接收方 id (userId/RoomId/GroupId)
179
+ * `type`: **(Required | number)** 接收方类型 (1:p2p, 2:group, 3:room)
180
+ * `timeout`: **(Optional | number)** 超时时间(ms), 默认: `20 * 1000`
181
+ * `callback`: **(Optional | function)** 回调方法, `callback(err, data)`
182
+ * `err`: **(Error)**
183
+ * `data`: **(object)**