api.md
## Modules
WKim/auth⇒object
权限认证相关接口方法集
WKim/conversation⇒object
会话管理，对会话进行增删查
WKim 主函数
WKim/user⇒object
用户信息操作相关接口方法集
Conv⇒instance
Conv 会话对象，包含会话操作相关的方法
follow⇒object
follow 关注方法集合
认证相关事件监听集
WKim/conversationListener⇒object
会话相关事件监听集
WKim/followListener⇒object
关注相关事件监听
WKim/messageListener⇒object
消息相关事件监听
Msg⇒instance
Msg 消息对象
End⇒over
End
## WKim/auth ⇒object权限认证相关接口方法集* [WKim/auth](#module_WKim/auth) ⇒object* [~login(options)](#module_WKim/auth..login) ⇒promise* [~logout()](#module_WKim/auth..logout) * [~kickout(deviceType, customText)](#module_WKim/auth..kickout) ⇒promise* [~getOpenId()](#module_WKim/auth..getOpenId) ⇒long* [~lastestAuthInfo()](#module_WKim/auth..lastestAuthInfo) ⇒object* [~setNickName()](#module_WKim/auth..setNickName)### WKim/auth~login(options) ⇒promise登录，参数请参考 https://imwukong.com/#doc/doc/server/index.htm**Kind**: inner method of[WKim/auth](#module_WKim/auth)| Param | Type | Description || --- | --- | --- || options |object| 登录认证所需参数 |**Properties**| Name | Type || --- | --- || options.domain |string| | options.appKey |string| | options.openId |string| | options.nonce |string| | options.timestamp |string| | options.signature |string|### WKim/auth~logout()退出**Kind**: inner method of[WKim/auth](#module_WKim/auth)### WKim/auth~kickout(deviceType, customText) ⇒promise设备互踢下线**Kind**: inner method of[WKim/auth](#module_WKim/auth)| Param | Type | Description || --- | --- | --- || deviceType |int| 0:web; 1:app ; 2:全部 || customText |string| 系统消息提示文案 |### WKim/auth~getOpenId() ⇒long当前用户id**Kind**: inner method of[WKim/auth](#module_WKim/auth)### WKim/auth~lastestAuthInfo() ⇒object最后登录用户信息**Kind**: inner method of[WKim/auth](#module_WKim/auth)### WKim/auth~setNickName()设置一个昵称，不会远程更新自己的profile，**Kind**: inner method of[WKim/auth](#module_WKim/auth)## WKim/conversation ⇒object会话管理，对会话进行增删查* [WKim/conversation](#module_WKim/conversation) ⇒object* [~get(cid)](#module_WKim/conversation..get) ⇒object|promise* [~getConvByCache(cid)](#module_WKim/conversation..getConvByCache) ⇒object* [~list(cursor, count)](#module_WKim/conversation..list) ⇒object|promise* [~listByTags(tags)](#module_WKim/conversation..listByTags) ⇒promise* [~create(options)](#module_WKim/conversation..create) ⇒promise* [~remove(cid)](#module_WKim/conversation..remove) ⇒promise* [~removeConversations(cids)](#module_WKim/conversation..removeConversations) ⇒promise* [~getTotalUnreadCount()](#module_WKim/conversation..getTotalUnreadCount) ⇒promise### WKim/conversation~get(cid) ⇒object|promise获取一个会话对象**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)**Returns**:object- conv instancepromise| Param | Type | Description || --- | --- | --- || cid |string| conversationId |### WKim/conversation~getConvByCache(cid) ⇒object从缓存中取**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)**Returns**:object- conv instance or undefined; | Param | Type | Description || --- | --- | --- || cid |string| conversationId |### WKim/conversation~list(cursor, count) ⇒object|promise获取会话列表**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)**Returns**:object- convListpromise| Param | Type | Description || --- | --- | --- || cursor |long| 游标位置 || count |int| 数量 |### WKim/conversation~listByTags(tags) ⇒promise通过tag获取会话列表**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)| Param | Type || --- | --- || tags |array|### WKim/conversation~create(options) ⇒promise创建会话**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)| Param | Type || --- | --- || options |object|### WKim/conversation~remove(cid) ⇒promise删除一个会话**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)| Param | Type || --- | --- || cid |string|### WKim/conversation~removeConversations(cids) ⇒promise批量删除会话**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)| Param | Type | Description || --- | --- | --- || cids |array| conversationIds |### WKim/conversation~getTotalUnreadCount() ⇒promise获取所有会话的未读数量**Kind**: inner method of[WKim/conversation](#module_WKim/conversation)## WKimWKim 主函数* [WKim](#module_WKim) * [~version](#module_WKim..version) * [~config](#module_WKim..config) * [~conversationListener](#module_WKim..conversationListener) * [~authListener](#module_WKim..authListener) * [~followListener](#module_WKim..followListener) * [~messageListener](#module_WKim..messageListener) * [~userListener](#module_WKim..userListener) * [~conversaion](#module_WKim..conversaion) * [~auth](#module_WKim..auth) * [~user](#module_WKim..user) * [~follow](#module_WKim..follow) * [~ws](#module_WKim..ws) * [~reg](#module_WKim..reg) * [~upload](#module_WKim..upload)### WKim~version当前sdk版本**Kind**: inner property of[WKim](#module_WKim)### WKim~config一些配置**Kind**: inner property of[WKim](#module_WKim)### WKim~conversationListener会话相关事件监听器**Kind**: inner property of[WKim](#module_WKim)### WKim~authListener认证相关事件监听器**Kind**: inner property of[WKim](#module_WKim)### WKim~followListener关注事件监听器**Kind**: inner property of[WKim](#module_WKim)### WKim~messageListener消息事件监听器**Kind**: inner property of[WKim](#module_WKim)### WKim~userListener用户信息事件监听器**Kind**: inner property of[WKim](#module_WKim)### WKim~conversaion会话管理相关接口方法集**Kind**: inner property of[WKim](#module_WKim)### WKim~auth权限认证相关接口方法集**Kind**: inner property of[WKim](#module_WKim)### WKim~user用户信息操作方法集**Kind**: inner property of[WKim](#module_WKim)### WKim~follow关注方法集**Kind**: inner property of[WKim](#module_WKim)### WKim~ws通道复用(开发中...)**Kind**: inner property of[WKim](#module_WKim)### WKim~reg注册建立连接**Kind**: inner property of[WKim](#module_WKim)| Param | Type || --- | --- || options.appKey |string|### WKim~upload文件上传，音频转换**Kind**: inner property of[WKim](#module_WKim)## WKim/user ⇒object用户信息操作相关接口方法集* [WKim/user](#module_WKim/user) ⇒object* [~getProfiles](#module_WKim/user..getProfiles) ⇒promise* [~updateProfile](#module_WKim/user..updateProfile) ⇒promise* [~remarkListAll](#module_WKim/user..remarkListAll) ⇒promise### WKim/user~getProfiles ⇒promise批量获取用户信息**Kind**: inner property of[WKim/user](#module_WKim/user)| Param | Type || --- | --- || openIds |array|### WKim/user~updateProfile ⇒promise更新当前登录用户信息**Kind**: inner property of[WKim/user](#module_WKim/user)| Param | Type || --- | --- || options |object|### WKim/user~remarkListAll ⇒promise拉取当前登录用户对其他人的备注列表**Kind**: inner property of[WKim/user](#module_WKim/user)## Conv ⇒instanceConv 会话对象，包含会话操作相关的方法* [Conv](#module_Conv) ⇒instance* [~cid](#module_Conv..cid) * [~isSingleChat](#module_Conv..isSingleChat) * [~isToMySelf](#module_Conv..isToMySelf) * [~nextPullOver](#module_Conv..nextPullOver) * [~listPreviousMessages(msg, count)](#module_Conv..listPreviousMessages) ⇒promise* [~listNextMessages(msg, count)](#module_Conv..listNextMessages) ⇒promise* [~sendText(text)](#module_Conv..sendText) ⇒promise* [~sendImg(mediaId, photoSize)](#module_Conv..sendImg) ⇒promise* [~send(msg)](#module_Conv..send) ⇒promise* [~getTitle()](#module_Conv..getTitle) ⇒string* [~getIcon()](#module_Conv..getIcon) ⇒string* [~updateTitle(newTitle)](#module_Conv..updateTitle) ⇒promise* [~updateIcon(icon)](#module_Conv..updateIcon) ⇒promise* [~getMembers(cursor, count)](#module_Conv..getMembers) ⇒promise* [~addMembers(openIds, customText)](#module_Conv..addMembers) ⇒promise* [~removeMembers(openIds, receivers, customText)](#module_Conv..removeMembers) ⇒promise* [~setTop(isTop)](#module_Conv..setTop) ⇒promise* [~disband()](#module_Conv..disband) ⇒promise* [~quitSilent(customText)](#module_Conv..quitSilent) ⇒promise* [~quit(customText)](#module_Conv..quit) ⇒promise* [~hide()](#module_Conv..hide) ⇒promise* [~clearMsg()](#module_Conv..clearMsg) ⇒promise* [~updateNotification(status)](#module_Conv..updateNotification) ⇒promise* [~updateNotificationSound(sound)](#module_Conv..updateNotificationSound) ⇒promise* [~updateAuthority(authority)](#module_Conv..updateAuthority) ⇒promise* [~updateMemberLimit(memberLimit)](#module_Conv..updateMemberLimit) ⇒promise* [~updateSuperGroup(superGroup)](#module_Conv..updateSuperGroup) ⇒promise* [~updateStatus(status)](#module_Conv..updateStatus) ⇒promise* [~getCode()](#module_Conv..getCode) ⇒promise* [~updateTag(tag)](#module_Conv..updateTag) ⇒promise* [~updateExtension(map)](#module_Conv..updateExtension) ⇒promise* [~updateMemberExtension(openIds, map)](#module_Conv..updateMemberExtension) ⇒promise* [~updateOwner(openId, customText)](#module_Conv..updateOwner) ⇒promise* [~updateInfo(obj)](#module_Conv..updateInfo) ⇒promise* [~getMsgById(messageId)](#module_Conv..getMsgById) ⇒instance* [~read(messageIds)](#module_Conv..read) * [~clearUnreadPoint()](#module_Conv..clearUnreadPoint) ⇒promise* [~sendTyping(command)](#module_Conv..sendTyping) ⇒promise### Conv~cid当前会话id**Kind**: inner property of[Conv](#module_Conv)### Conv~isSingleChat判断是否单聊**Kind**: inner property of[Conv](#module_Conv)### Conv~isToMySelf判断是否自己和自己聊的会话**Kind**: inner property of[Conv](#module_Conv)### Conv~nextPullOver判断是否还有历史消息**Kind**: inner property of[Conv](#module_Conv)### Conv~listPreviousMessages(msg, count) ⇒promise上拉消息，例如:昨天某个时刻开始拉到今天**Kind**: inner method of[Conv](#module_Conv)**Returns**:promise- conv array | Param | Type | Description || --- | --- | --- || msg |object| 提供一个消息对象作为拉取的坐标位 || count |int| 拉取数量 |### Conv~listNextMessages(msg, count) ⇒promise下拉消息，例如:今天某个时刻开始拉到昨天**Kind**: inner method of[Conv](#module_Conv)**Returns**:promise- conv array | Param | Type | Description || --- | --- | --- || msg |object| 提供一个消息对象作为拉取的坐标位，第一次可以传null || count |int| 拉取数量 |### Conv~sendText(text) ⇒promise发送文本消息**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || text |string|### Conv~sendImg(mediaId, photoSize) ⇒promise发送图片消息**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || mediaId |string| | photoSize |int|### Conv~send(msg) ⇒promise发送自定义消息**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || msg |string|### Conv~getTitle() ⇒string获取会话标题**Kind**: inner method of[Conv](#module_Conv)**Returns**:string- or {long}### Conv~getIcon() ⇒string获取会话图标**Kind**: inner method of[Conv](#module_Conv)### Conv~updateTitle(newTitle) ⇒promise更新会话标题**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || newTitle |string|### Conv~updateIcon(icon) ⇒promise更新会话图标**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || icon |string|### Conv~getMembers(cursor, count) ⇒promise获取成员列表**Kind**: inner method of[Conv](#module_Conv)| Param | Description || --- | --- || cursor | 游标 || count | 长度 |### Conv~addMembers(openIds, customText) ⇒promise批量添加成员**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || openIds |array| 成员id集合 || customText |string| 系统消息文案 |### Conv~removeMembers(openIds, receivers, customText) ⇒promise批量删除成员**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || openIds |array| 成员的id集合 || receivers |string| 指定接受通知的成员id集合 || customText |string| 系统消息文案 |### Conv~setTop(isTop) ⇒promise置顶会话**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || isTop |boolean| true：置顶，false：取消置顶 |### Conv~disband() ⇒promise解散**Kind**: inner method of[Conv](#module_Conv)### Conv~quitSilent(customText) ⇒promise静默退出**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || customText |string| 系统消息文案 |### Conv~quit(customText) ⇒promise退出**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || customText |string| 系统消息文案 |### Conv~hide() ⇒promise隐藏会话**Kind**: inner method of[Conv](#module_Conv)### Conv~clearMsg() ⇒promise清空消息**Kind**: inner method of[Conv](#module_Conv)### Conv~updateNotification(status) ⇒promise更新XPN状态**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || status |int| 0: 接收通知，1: 不接收通知 |### Conv~updateNotificationSound(sound) ⇒promise更新会话提示音**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || sound |string| 声音 |### Conv~updateAuthority(authority) ⇒promise更新会话权限**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || authority |int| 0-默认，群成员都可以加人，1-只有群主可以加人 |### Conv~updateMemberLimit(memberLimit) ⇒promise更新会话成员数量限制**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || memberLimit |int|### Conv~updateSuperGroup(superGroup) ⇒promise更新群等级**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || superGroup |int| 0:普通，1:大群 |### Conv~updateStatus(status) ⇒promise更新会话状态**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || status |int| 0:隐藏 1:可见 |### Conv~getCode() ⇒promise获取会话二维码**Kind**: inner method of[Conv](#module_Conv)### Conv~updateTag(tag) ⇒promise更新会话tag**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || tag |int|### Conv~updateExtension(map) ⇒promise更新会话扩展**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || map |object|### Conv~updateMemberExtension(openIds, map) ⇒promise更新成员扩展**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || openIds |array| 成员id集合 || map |object| 例如 {'a':'123'} |### Conv~updateOwner(openId, customText) ⇒promise换群主**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || openId |long| 成员id || customText |string| 系统消息文案 |### Conv~updateInfo(obj) ⇒promise更新会话信息**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || obj |object| 目前只支持tag 和 extension |### Conv~getMsgById(messageId) ⇒instance获取单个消息**Kind**: inner method of[Conv](#module_Conv)**Returns**:instance- msg | Param | Type || --- | --- || messageId |long|### Conv~read(messageIds)批量设置已读**Kind**: inner method of[Conv](#module_Conv)| Param | Type || --- | --- || messageIds |array|### Conv~clearUnreadPoint() ⇒promise清除红点**Kind**: inner method of[Conv](#module_Conv)### Conv~sendTyping(command) ⇒promise发送typing**Kind**: inner method of[Conv](#module_Conv)| Param | Type | Description || --- | --- | --- || command |int| 0-正在typing，1-取消typing |## follow ⇒objectfollow 关注方法集合* [follow](#module_follow) ⇒object* [~listFansAll](#module_follow..listFansAll) * [~listAll](#module_follow..listAll) * [~follow](#module_follow..follow) * [~unfollow](#module_follow..unfollow) * [~getStatus](#module_follow..getStatus)### follow~listFansAll获取关注自己的的人列表（粉丝）， 第一次调cursor可以传null,**Kind**: inner property of[follow](#module_follow)| Param | Description || --- | --- || tag | 自定义的筛选标记,不能为负值 || cursor | 每次获取的起始位置 || count | 每次获取的条数 || callback | |### follow~listAll获取自己关注的人列表**Kind**: inner property of[follow](#module_follow)| Param | Description || --- | --- || tag | 自定义的筛选标记,不能为负值 || cursor | 每次获取的起始位置 || count | 每次获取的条数 || callback | |### follow~follow关注某个人**Kind**: inner property of[follow](#module_follow)| Param | Description || --- | --- || tag | 自定义的筛选标记,不能为负值 || openId | || callback | |### follow~unfollow取消关注某个人**Kind**: inner property of[follow](#module_follow)| Param | Description || --- | --- || tag | 自定义的筛选标记,不能为负值 || openId | || callback | |### follow~getStatus获取某个人的关系状态**Kind**: inner property of[follow](#module_follow)| Param | Description || --- | --- || tag | 自定义的筛选标记,不能为负值 || openId | || callback | |## WKim/authListener认证相关事件监听集* [WKim/authListener](#module_WKim/authListener) * ["logining"](#event_logining) * ["loginFail"](#event_loginFail) * ["loginSuccess"](#event_loginSuccess) * ["logout"](#event_logout) * ["kickout"](#event_kickout) * ["devSts"](#event_devSts) * ["stateChange" (state)](#event_stateChange)### "logining"登录中**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)### "loginFail"登录失败**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)### "loginSuccess"登录成功**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)### "logout"主动退出**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)### "kickout"被踢下线**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)### "devSts"设备上下线和状态通知**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)| Param | Description || --- | --- || options.deviceType | 1-web，2-android，3-iOS || options.type | 1-事件通知（上下线动作），2-状态通知（在线状态） || options.status | 1-上线（在线），2-下线（离线） || options.time | 推送产生时的时间戳 |### "stateChange" (state)连接层状态变更**Kind**: event emitted by[WKim/authListener](#module_WKim/authListener)| Param | Description || --- | --- || state | "CONNECTING","OPEN","CLOSING","CLOSED","REGED" |## WKim/conversationListener ⇒object会话相关事件监听集* [WKim/conversationListener](#module_WKim/conversationListener) ⇒object* ["convAdd" (conv)](#event_convAdd) * ["convRemove" (conv)](#event_convRemove) * ["convUnreadPointChange" (conv)](#event_convUnreadPointChange) * ["convTitleChange" (conv)](#event_convTitleChange) * ["convIconChange" (conv)](#event_convIconChange) * ["convStatusChange" (conv)](#event_convStatusChange) * ["convLastMessageChange" (conv)](#event_convLastMessageChange) * ["convDraftChange" (conv)](#event_convDraftChange) * ["convTagChange" (conv)](#event_convTagChange) * ["convExtensionChange" (conv)](#event_convExtensionChange) * ["convAtMeStatusChange" (conv)](#event_convAtMeStatusChange) * ["convNotificationChange" (conv)](#event_convNotificationChange) * ["convMemberCountChange" (conv)](#event_convMemberCountChange) * ["convNotificationSoundChange" (conv)](#event_convNotificationSoundChange) * ["convAuthorityChange" (conv)](#event_convAuthorityChange) * ["convTyping" (conv)](#event_convTyping) * ["convMemberLimitChange" (conv)](#event_convMemberLimitChange) * ["convGroupLevelChange" (conv)](#event_convGroupLevelChange) * ["convClearMessage" (conv)](#event_convClearMessage) * ["convQuit" (conv)](#event_convQuit) * ["convKicked" (conv)](#event_convKicked) * ["convDisband" (conv)](#event_convDisband) * ["convSetTop" (conv)](#event_convSetTop) * ["convToFirst" (conv)](#event_convToFirst)### "convAdd" (conv)新增会话**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convRemove" (conv)删除会话**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convUnreadPointChange" (conv)会话未读消息数量改变**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convTitleChange" (conv)会话标题变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convIconChange" (conv)会话icon变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convStatusChange" (conv)会话状态变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convLastMessageChange" (conv)最后一条消息**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convDraftChange" (conv)草稿**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convTagChange" (conv)tag**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convExtensionChange" (conv)**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convAtMeStatusChange" (conv)我状态**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convNotificationChange" (conv)会话是否通知的状态变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convMemberCountChange" (conv)会话成员数变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convNotificationSoundChange" (conv)会话通知声音变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convAuthorityChange" (conv)会话权限变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convTyping" (conv)正在输入**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type | Description || --- | --- | --- || conv |instance| Conversation conversation,TypingCommand command,TypingType type |### "convMemberLimitChange" (conv)会话成员数限制变更**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convGroupLevelChange" (conv)会话等级变更，比如升级为大群**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convClearMessage" (conv)会话消息被清空**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convQuit" (conv)主动退出**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convKicked" (conv)被踢出**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convDisband" (conv)会话解散**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convSetTop" (conv)会话置顶**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|### "convToFirst" (conv)会话提前**Kind**: event emitted by[WKim/conversationListener](#module_WKim/conversationListener)| Param | Type || --- | --- || conv |instance|## WKim/followListener ⇒object关注相关事件监听### "followChange" (关注改变信息队列)关注状态改变**Kind**: event emitted by[WKim/followListener](#module_WKim/followListener)| Param | Type || --- | --- || 关注改变信息队列 |object|## WKim/messageListener ⇒object消息相关事件监听* [WKim/messageListener](#module_WKim/messageListener) ⇒object* ["msgStatusChange" (msg)](#event_msgStatusChange) * ["msgInfoChange" (msg)](#event_msgInfoChange) * ["msgReceive" (msg)](#event_msgReceive) * ["msgRemove" (msg)](#event_msgRemove) * ["sendSuccess" (msg)](#event_sendSuccess) * ["sendFail" (msg)](#event_sendFail) * ["sendFail" (msg)](#event_sendFail)### "msgStatusChange" (msg)消息状态改变**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|### "msgInfoChange" (msg)消息信息改变**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|### "msgReceive" (msg)接收到消息**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|### "msgRemove" (msg)消息删除**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|### "sendSuccess" (msg)消息发送成功**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|### "sendFail" (msg)消息发送失败**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|### "sendFail" (msg)自定义推送消息**Kind**: event emitted by[WKim/messageListener](#module_WKim/messageListener)| Param | Type || --- | --- || msg |instance|## Msg ⇒instanceMsg 消息对象* [Msg](#module_Msg) ⇒instance* [~getId()](#module_Msg..getId) ⇒long* [~getOpenId()](#module_Msg..getOpenId) ⇒long* [~getConvId()](#module_Msg..getConvId) ⇒string* [~unReadCount()](#module_Msg..unReadCount) ⇒int* [~unreadMembers()](#module_Msg..unreadMembers) ⇒promise* [~updateToRead()](#module_Msg..updateToRead) * [~updateAudioMsgToRead()](#module_Msg..updateAudioMsgToRead) * [~isMe()](#module_Msg..isMe) ⇒boolean* [~isSys()](#module_Msg..isSys) ⇒boolean* [~isSound()](#module_Msg..isSound) ⇒boolean* [~isPhoto()](#module_Msg..isPhoto) ⇒boolean* [~isMedia()](#module_Msg..isMedia) ⇒boolean* [~isRead()](#module_Msg..isRead) ⇒boolean* [~recallMessage()](#module_Msg..recallMessage) ⇒promise* [~remove()](#module_Msg..remove) ⇒promise### Msg~getId() ⇒long获取messageId**Kind**: inner method of[Msg](#module_Msg)### Msg~getOpenId() ⇒long获取该消息的openId**Kind**: inner method of[Msg](#module_Msg)### Msg~getConvId() ⇒string获取该消息的会话id**Kind**: inner method of[Msg](#module_Msg)### Msg~unReadCount() ⇒int未读数**Kind**: inner method of[Msg](#module_Msg)### Msg~unreadMembers() ⇒promise未读人员列表**Kind**: inner method of[Msg](#module_Msg)### Msg~updateToRead()设置已读**Kind**: inner method of[Msg](#module_Msg)### Msg~updateAudioMsgToRead()设置语音消息已读**Kind**: inner method of[Msg](#module_Msg)### Msg~isMe() ⇒boolean是不是当前用户发的**Kind**: inner method of[Msg](#module_Msg)### Msg~isSys() ⇒boolean是不是系统消息**Kind**: inner method of[Msg](#module_Msg)### Msg~isSound() ⇒boolean是不是语音消息**Kind**: inner method of[Msg](#module_Msg)### Msg~isPhoto() ⇒boolean是不是图片消息**Kind**: inner method of[Msg](#module_Msg)### Msg~isMedia() ⇒boolean是不是多媒体-非文本类型消息**Kind**: inner method of[Msg](#module_Msg)### Msg~isRead() ⇒boolean是不是已读消息**Kind**: inner method of[Msg](#module_Msg)### Msg~recallMessage() ⇒promise消息撤回**Kind**: inner method of[Msg](#module_Msg)### Msg~remove() ⇒promise消息删除**Kind**: inner method of[Msg](#module_Msg)## End ⇒overEnd* [End](#module_End) ⇒over* [module.exports](#exp_module_End--module.exports) ⏏ * [module.exports](#exp_module_End--module.exports) ⏏### module.exports ⏏Module exports.**Kind**: Exported member### module.exports ⏏Calls a task as soon as possible after returning, in its own event, with priorityover other events like animation, reflow, and repaint. An error thrown from anevent will not interrupt, nor even substantially slow down the processing ofother events, but will be rather postponed to a lower priority event.**Kind**: Exported member | Param | Type | Description || --- | --- | --- || task |Object| A callable object, typically a function that takes no arguments. |
