WuKongIM Docs

JavaScript / Web API 参考

按管理器快速查找 wukongimjssdk 常用配置、监听器、Provider 和模型。

编辑此页报告文档问题

本页是常用入口速查,不替代各任务页面。根单例是 WKSDK.shared()

WKSDK 与配置

API用途
WKSDK.shared()当前页面上下文的 SDK 单例
config.uid / config.token当前用户身份
config.addrWebSocket 地址
config.deviceFlag0 App、1 Web、2 PC
config.provider业务数据源集合
connect() / disconnect()连接和停止连接
register(type, factory)注册自定义消息正文
newChannel / newMessageText创建常用模型的便捷方法

ConnectManager

API用途
addConnectStatusListener监听连接状态
removeConnectStatusListener移除状态监听
addConnectDelayListener监听心跳延迟
removeConnectDelayListener移除延迟监听
status当前 ConnectStatus

状态:DisconnectConnectedConnectingConnectFailConnectKick

ChatManager

API用途
send(content, channel, setting?)发送消息并返回本地 Message
sendWithOptions(content, channel, options)带高级选项发送
addMessageListener / removeMessageListener监听所有收发消息
addMessageStatusListener / removeMessageStatusListener监听服务器发送结果
syncMessages(channel, options)通过 Provider 同步消息
syncMessageExtras同步消息扩展数据

ConversationManager

API用途
sync(filter?)从业务 Provider 同步会话
conversations当前内存会话列表
findConversation(channel)查找一个会话
createEmptyConversation(channel)创建空会话
removeConversation(channel)移除内存列表项
getAllUnreadCount()统计总未读数
addConversationListener / removeConversationListener监听列表变化

ChannelManager

API用途
fetchChannelInfo(channel)通过 Provider 获取资料
getChannelInfo(channel)读取缓存资料
addListener / removeListener监听资料变化
syncSubscribes(channel)同步群订阅者
getSubscribes(channel)读取缓存订阅者

常用 Provider

配置返回值
connectAddrCallback通过 callback 返回 WebSocket 地址
channelInfoCallbackPromise<ChannelInfo>
syncSubscribersCallbackPromise<Subscriber[]>
syncConversationsCallbackPromise<Conversation[]>
syncMessagesCallbackPromise<Message[]>
messageUploadTaskCallbackMessageTask

常用模型

ChannelChannelInfoSubscriberMessageMessageContentMessageTextMessageImageConversationSyncOptionsSendOptions

常用频道类型:ChannelTypePersonChannelTypeGroup。本地消息状态:MessageStatus.WaitMessageStatus.NormalMessageStatus.Fail

本页内容