@typexim/web-sdk 0.0.4-alpha.0 → 0.0.4-alpha.2
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.
- package/README.md +96 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# TypeX WEB SDK
|
|
2
|
+
|
|
3
|
+
## 调用方式
|
|
4
|
+
|
|
5
|
+
```javascript
|
|
6
|
+
import { create, enums, events } from '@typexim/web-sdk';
|
|
7
|
+
|
|
8
|
+
const chat = create({
|
|
9
|
+
httpHost: 'https://coco.typex.im',
|
|
10
|
+
websocketHost: 'wss://w.typexim.com'
|
|
11
|
+
})
|
|
12
|
+
|
|
13
|
+
chat.setLogLevel(enums.LogLevel.info);
|
|
14
|
+
|
|
15
|
+
chat.login({
|
|
16
|
+
user_code: 'xxxx'
|
|
17
|
+
});
|
|
18
|
+
chat.once(
|
|
19
|
+
events.CHAT_SDK_EVENT.SDK_READY,
|
|
20
|
+
async () => {
|
|
21
|
+
chat.on(
|
|
22
|
+
events.CHAT_SDK_EVENT.FEED_LIST_UPDATED
|
|
23
|
+
({ is_sync_completed, list }) => {
|
|
24
|
+
console.log('feed列表', list);
|
|
25
|
+
}
|
|
26
|
+
);
|
|
27
|
+
|
|
28
|
+
const result = await chat.getFeedList();
|
|
29
|
+
if (result.ok) {
|
|
30
|
+
console.log('feed列表', result.data.list);
|
|
31
|
+
} else {
|
|
32
|
+
console.log(result.code);
|
|
33
|
+
console.log(result.msg);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## API清单
|
|
40
|
+
|
|
41
|
+
### 事件
|
|
42
|
+
|
|
43
|
+
1. on
|
|
44
|
+
2. off
|
|
45
|
+
|
|
46
|
+
### 事件码
|
|
47
|
+
|
|
48
|
+
1. SDK_READY
|
|
49
|
+
2. SDK_NOT_READY
|
|
50
|
+
3. MESSAGE_RECEIVED
|
|
51
|
+
4. MESSAGE_UPDATED
|
|
52
|
+
5. MESSAGE_RECEIPT_RECEIVED
|
|
53
|
+
6. FEED_LIST_UPDATED
|
|
54
|
+
7. ROOM_MESSAGE_RECEIVED
|
|
55
|
+
|
|
56
|
+
### 初始化
|
|
57
|
+
|
|
58
|
+
1. create
|
|
59
|
+
|
|
60
|
+
### 设置日志级别
|
|
61
|
+
|
|
62
|
+
1. setLogLevel
|
|
63
|
+
|
|
64
|
+
### SDK是否ready
|
|
65
|
+
|
|
66
|
+
1. isReady
|
|
67
|
+
|
|
68
|
+
### 登录
|
|
69
|
+
|
|
70
|
+
1. login
|
|
71
|
+
2. logout
|
|
72
|
+
3. getLoginUser
|
|
73
|
+
|
|
74
|
+
### 会话Feed
|
|
75
|
+
|
|
76
|
+
1. createSingleChatFeed
|
|
77
|
+
2. deleteFeed
|
|
78
|
+
3. getFeedList(不分页，最多100条)
|
|
79
|
+
4. getFeedDetail
|
|
80
|
+
|
|
81
|
+
### 会话Feed消息
|
|
82
|
+
|
|
83
|
+
1. getFeedMessageList(分页)
|
|
84
|
+
2. createCustomMessage
|
|
85
|
+
3. sendMessageToFeed
|
|
86
|
+
4. sendMessageReadReceipt
|
|
87
|
+
|
|
88
|
+
### 聊天室Room
|
|
89
|
+
|
|
90
|
+
1. joinRoom
|
|
91
|
+
2. leaveRoom
|
|
92
|
+
|
|
93
|
+
### 聊天室Room消息
|
|
94
|
+
|
|
95
|
+
1. getRoomRecentMessageList(最近50条)
|
|
96
|
+
2. sendMessageToRoom
|