rosterManage#

rosterManage#

好友管理

• rosterManage
• .asyncGetRosterIdList(force) ⇒ Promise.<Array.<number>>
• .asyncGetRosterInfo(roster_id, force) ⇒ Promise.<RosterItem>
• .asyncDeleteRoster(param) ⇒ Promise.<boolean>
• .asnycGetRosterListDetailByIds(roster_ids) ⇒ Promise.<Array.<module:types~RosterItem>>
• .getAllRosterDetail() ⇒ Array.<RosterItem>
• .asyncGetUserProfile(force) ⇒ Promise.<UserProfile>
• .getRosterMessageByRid(uid) ⇒ Array.<Meta>
• .readRosterMessage(roster_id, mid)
• .recallMessage(uid, mid)
• .unreadMessage(uid, mid)
• .deleteMessage(uid, mid)
• .appendMessageContent(uid, mid, content)
• .replaceMessage(uid, mid, content, config, ext)
• .getRosterInfo(rid) ⇒ RosterItem
• .getUnreadCount(uid) ⇒ number
• .asyncGetApplyList(params) ⇒ Promise.<Array.<module:types~RosterApplication>>
• .asyncGetBlockedlist(params) ⇒ Promise.<Array.<number>>
• .asyncBlockeAdd(params) ⇒ Promise.<boolean>
• .asyncBlockeRemove(params) ⇒ Promise.<boolean>
• .asyncApply(params) ⇒ Promise.<boolean>
• .asyncAccept(params) ⇒ Promise.<boolean>
• .asyncDecline(params) ⇒ Promise.<boolean>
• .asyncUpdateRosterExt(params) ⇒ Promise.<boolean>
• .asyncUpdateRosterAlias(params) ⇒ Promise.<boolean>
• .asyncSearchRosterByName(params) ⇒ Promise.<RosterItem>
• .asyncSearchRosterById(params) ⇒ Promise.<RosterItem>

rosterManage.asyncGetRosterIdList(force) ⇒ Promise.<Array.<number>>#

获取好友id列表

Kind: static method of rosterManage
Returns: Promise.<Array.<number>> - 用户ID列表

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetRosterIdList" %}{% endlanying_code_snippet %}

rosterManage.asyncGetRosterInfo(roster_id, force) ⇒ Promise.<RosterItem>#

获取好友信息

Kind: static method of rosterManage
Returns: Promise.<RosterItem> - 好友信息

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetRosterInfo" %}{% endlanying_code_snippet %}

rosterManage.asyncDeleteRoster(param) ⇒ Promise.<boolean>#

删除好友

Kind: static method of rosterManage
Returns: Promise.<boolean> - 请求结果

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncDeleteRoster" %}{% endlanying_code_snippet %}

rosterManage.asnycGetRosterListDetailByIds(roster_ids) ⇒ Promise.<Array.<module:types~RosterItem>>#

根据id列表获取用户详细信息

Kind: static method of rosterManage
Returns: Promise.<Array.<module:types~RosterItem>> - 用户详细信息列表

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asnycGetRosterListDetailByIds" %}{% endlanying_code_snippet %}

rosterManage.getAllRosterDetail() ⇒ Array.<RosterItem>#

获取缓存的所有用户详细信息

Kind: static method of rosterManage
Returns: Array.<RosterItem> - 用户详细信息列表
Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getAllRosterDetail" %}{% endlanying_code_snippet %}

rosterManage.asyncGetUserProfile(force) ⇒ Promise.<UserProfile>#

获取自己的用户信息

Kind: static method of rosterManage
Returns: Promise.<UserProfile> - 用户信息

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetUserProfile" %}{% endlanying_code_snippet %}

rosterManage.getRosterMessageByRid(uid) ⇒ Array.<Meta>#

根据会话ID获取聊天消息

Kind: static method of rosterManage
Returns: Array.<Meta> - 聊天消息列表

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getRosterMessageByRid" %}{% endlanying_code_snippet %}

rosterManage.readRosterMessage(roster_id, mid)#

修改消息状态为已读

Kind: static method of rosterManage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="readRosterMessage" %}{% endlanying_code_snippet %}

rosterManage.recallMessage(uid, mid)#

撤回消息，只能撤回5分钟内的

Kind: static method of rosterManage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="recallMessage" %}{% endlanying_code_snippet %}

rosterManage.unreadMessage(uid, mid)#

设置消息成未读

Kind: static method of rosterManage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="unreadMessage" %}{% endlanying_code_snippet %}

rosterManage.deleteMessage(uid, mid)#

删除消息

Kind: static method of rosterManage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="deleteMessage" %}{% endlanying_code_snippet %}

rosterManage.appendMessageContent(uid, mid, content)#

追加消息内容

Kind: static method of rosterManage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="appendMessageContent" %}{% endlanying_code_snippet %}

rosterManage.replaceMessage(uid, mid, content, config, ext)#

更新消息内容

Kind: static method of rosterManage

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="replaceMessage" %}{% endlanying_code_snippet %}

rosterManage.getRosterInfo(rid) ⇒ RosterItem#

获取好友信息

Kind: static method of rosterManage
Returns: RosterItem - 好友信息

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getRosterInfo" %}{% endlanying_code_snippet %}

rosterManage.getUnreadCount(uid) ⇒ number#

获取指定会话的未读数

Kind: static method of rosterManage
Returns: number - 未读数

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="getUnreadCount" %}{% endlanying_code_snippet %}

rosterManage.asyncGetApplyList(params) ⇒ Promise.<Array.<module:types~RosterApplication>>#

获取好友申请列表

Kind: static method of rosterManage
Returns: Promise.<Array.<module:types~RosterApplication>> - 好友申请列表

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetApplyList" %}{% endlanying_code_snippet %}

rosterManage.asyncGetBlockedlist(params) ⇒ Promise.<Array.<number>>#

获取黑名单

Kind: static method of rosterManage
Returns: Promise.<Array.<number>> - 用户ID列表

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncGetBlockedlist" %}{% endlanying_code_snippet %}

rosterManage.asyncBlockeAdd(params) ⇒ Promise.<boolean>#

加入黑名单

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncBlockeAdd" %}{% endlanying_code_snippet %}

rosterManage.asyncBlockeRemove(params) ⇒ Promise.<boolean>#

移除黑名单

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncBlockeRemove" %}{% endlanying_code_snippet %}

rosterManage.asyncApply(params) ⇒ Promise.<boolean>#

请求加为好友

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncApply" %}{% endlanying_code_snippet %}

rosterManage.asyncAccept(params) ⇒ Promise.<boolean>#

通过好友申请

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncAccept" %}{% endlanying_code_snippet %}

rosterManage.asyncDecline(params) ⇒ Promise.<boolean>#

拒绝好友申请

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncDecline" %}{% endlanying_code_snippet %}

rosterManage.asyncUpdateRosterExt(params) ⇒ Promise.<boolean>#

修改好友扩展字段

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncUpdateRosterExt" %}{% endlanying_code_snippet %}

rosterManage.asyncUpdateRosterAlias(params) ⇒ Promise.<boolean>#

修改好友扩展别名字段

Kind: static method of rosterManage
Returns: Promise.<boolean> - 是否成功

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncUpdateRosterAlias" %}{% endlanying_code_snippet %}

rosterManage.asyncSearchRosterByName(params) ⇒ Promise.<RosterItem>#

按名称搜索用户

Kind: static method of rosterManage
Returns: Promise.<RosterItem> - 用户信息

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncSearchRosterByName" %}{% endlanying_code_snippet %}

rosterManage.asyncSearchRosterById(params) ⇒ Promise.<RosterItem>#

按ID搜索用户

Kind: static method of rosterManage
Returns: Promise.<RosterItem> - 用户信息

Example

{% lanying_code_snippet repo="lanying-im-web",class="rosterManage",function="asyncSearchRosterById" %}{% endlanying_code_snippet %}