@typexim/web-sdk
v0.0.5-alpha.2
Published
## 调用方式
Downloads
50
Keywords
Readme
TypeX WEB SDK
调用方式
import { create, enums, events } from '@typexim/web-sdk';
const chat = create('sdk', {
httpHost: 'https://coco.typex.im',
websocketHost: 'wss://w.typexim.com'
})
chat.setLogLevel(enums.LogLevel.info);
chat.login({
user_code: 'xxxx'
});
chat.once(
events.CHAT_SDK_EVENT.SDK_READY,
async () => {
chat.on(
events.CHAT_SDK_EVENT.FEED_LIST_UPDATED
({ is_sync_completed, list }) => {
console.log('feed列表', list);
}
);
const result = await chat.getFeedList();
if (result.ok) {
console.log('feed列表', result.data.list);
} else {
console.log(result.code);
console.log(result.msg);
}
}
);API清单
事件
- on
- off
事件码
- SDK_READY
- SDK_NOT_READY
- MESSAGE_RECEIVED
- MESSAGE_EDITED
- MESSAGE_RECALLED
- MESSAGE_REACTION_UPDATED
- MESSAGE_RECEIPT_RECEIVED
- FEED_LIST_UPDATED
- ROOM_MESSAGE_RECEIVED
- SYSTEM_NOTICE_RECEIVED
初始化
- create
设置日志级别
- setLogLevel
SDK是否ready
- isReady
登录
- login
- logout
- getLoginUser
会话Feed
- createSingleChatFeed
- deleteFeed
- getFeedList(不分页,最多100条)
- getFeedDetail
- getFeedMemberList
会话Feed消息
- getFeedMessageList(分页)
- createCustomMessage
- sendMessageToFeed
- sendMessageReadReceipt
聊天室Room
- joinRoom
- leaveRoom
聊天室Room消息
- getRoomRecentMessageList(最近50条)
- sendMessageToRoom
注意事项
- 同个浏览器只有最先调用login成功的窗口可以正常使用,其他窗口要使用就得先在已登录的窗口调用logout或者关闭窗口
