bee.cloud.ri.mq

接口 IM.Work

封闭接口:

IM

public static interface IM.Work

业务数据处理接口

方法概要

限定符和类型	方法和说明
void	addGroupAdmin(java.lang.String groupId, java.lang.String... userId) 增加群管理员
java.lang.String	addGroupTeam(java.lang.String groupId, java.util.Map<java.lang.String,java.lang.String> teamInfo) 在群中增加团队
void	addGroupTeamUser(java.lang.String groupId, java.lang.String teamId, java.util.Set<java.lang.String> userId) 增加团队成员
void	addGroupUser(java.lang.String groupId, IM.User user) 增加群成员
void	addGroupUser(java.lang.String groupId, java.lang.String... userId) 增加群成员
void	addUserFriend(java.lang.String userId, java.lang.String friendId) 增加好友，双方的好友列表中都会增加
void	changeGroupLeader(java.lang.String groupId, java.lang.String userId) 更换群主
void	dissolveGroup(java.lang.String groupId) 解散群
void	exitGroup(java.lang.String groupId, java.lang.String... userId) 退出群或把某人移出群
java.lang.String	getCurUserId() 获取当前登录用户的ID
IM.Group	getGroup(java.lang.String groupId) 获取群信息
java.util.List<IM.User>	getGroupAdmin(java.lang.String groupId) 获取群管理员信息
java.util.Set<java.lang.String>	getGroupAdminId(java.lang.String groupId) 获取群管理员ID
IM.User	getGroupLeader(java.lang.String groupId) 获取群主信息
java.lang.String	getGroupLeaderId(java.lang.String groupId) 获取群主ID
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getGroupTeams(java.lang.String groupId, java.lang.String userId) 获取群中团队信息
java.util.List<IM.User>	getGroupTeamUser(java.lang.String groupId, java.lang.String teamId) 获取团队成员
java.util.Set<java.lang.String>	getGroupTeamUserId(java.lang.String groupId, java.lang.String teamId) 获取团队成员ID
IM.User	getGroupUser(java.lang.String groupId, java.lang.String userId) 获取群内用户信息，如用户在群内的备注等
java.util.List<java.lang.String>	getGroupUserIds(java.lang.String groupId) 获取群聊中的用户ID
java.util.List<IM.User>	getGroupUsers(java.lang.String groupId, int pageno, int pagesize) 获取群聊中的用户
java.util.List<IM.User>	getGroupUsersByTag(java.lang.String groupId, java.lang.String tagCode, int pageno, int pagesize) 根据标签获取群成员列表
IM.Oninfo	getOninfo(java.lang.String userId) 获取用户上线信息，包含上线时间与下线时间，不包括User
IM.User	getUser(java.lang.String userId) 获取单位用户信息
java.util.List<IM.User>	getUserFriends(java.lang.String userId) 获取用户的好友列表
java.util.List<IM.User>	getUserFriendsByTag(java.lang.String userId, java.lang.String tagCode) 根据标签获取用户的好友列表
java.util.List<IM.Group>	getUserGroups(java.lang.String userId) 获取用户所在分组列表
IM.User	getUserInfo(java.lang.String userId) 获取用户信息，需要业务系统实现
java.util.Map<java.lang.String,IM.User>	getUsers(java.util.Set<java.lang.String> userIds) 获取多个用户信息
void	offLine(IM.Oninfo oninfo) 下线事件
void	onLine(IM.Oninfo oninfo) 上线事件
java.util.List<IM.Body>	pullGroupMessage(java.lang.String userId, java.lang.String groupId, java.util.Date date, boolean isNext) 拉取聊聊历史消息，根据日期按天拉取
java.util.List<IM.Body>	pullMessageByTempId(java.lang.String tempid, java.util.Date time, int pagesize) 根据tempid获取消息记录
java.util.List<IM.Body>	pullNewMessage(java.lang.String userId) 拉取最新的新消息，主要提供给用户登录后一次性拉取最新的消息，只取最新100条
java.util.List<IM.NewMsgNum>	pullNewMessageNum(java.lang.String userId) 拉取用户最新消息的总数量，上一次离线后收到的消息数量
java.util.List<IM.Body>	pullSingleMessage(java.lang.String userId, java.lang.String toId, java.util.Date date, boolean isNext) 拉取单聊历史消息，根据日期按天拉取
void	removeGroup(java.lang.String groupId) 删除群聊
void	removeGroupAdmin(java.lang.String groupId, java.lang.String... userId) 移动群管理员
void	removeGroupTeam(java.lang.String groupId, java.lang.String teamId) 删除团队
void	removeGroupTeamUser(java.lang.String groupId, java.lang.String teamId, java.util.Set<java.lang.String> userId) 删除团队成员
void	removeGroupUser(java.lang.String groupId, java.lang.String... userId) 移动群成员
void	removeUserFriend(java.lang.String userId, java.lang.String... friendIds) 删除好友
boolean	saveGroup(IM.Group group) 保存群信息，只保存内容不为空的属性
boolean	saveGroupUser(java.lang.String groupId, IM.User user) 保存群用户，只保存内容不为空的属性
void	saveMessage(IM.Body body) 保存消息
void	saveUserInfo(IM.User user) 保存用户悠
void	setGroupAdmin(java.lang.String groupId, java.util.Set<java.lang.String> userIds) 替换群管理员
void	setGroupLeader(java.lang.String groupId, java.lang.String userId) 设置群主
void	setGroupUser(java.lang.String groupId, java.util.Set<java.lang.String> userIds) 替换群成员
void	setTagByFriend(java.lang.String userId, java.lang.String friendId, java.lang.String tagCode) 给好友加标签
void	setTagByGroup(java.lang.String userId, java.lang.String groupId, java.lang.String memberId, java.lang.String tagCode) 给好友加标签
void	updateGroupTeam(java.lang.String groupId, java.lang.String teamId, java.util.Map<java.lang.String,java.lang.String> teamInfo) 修改团队信息
void	updateReadGroupLasttime(java.lang.String userId, java.lang.String groupId) 更新群聊最后读取消息时间
void	updateReadSingleLasttime(java.lang.String userId, java.lang.String toId) 更新单聊最后读取消息时间

方法详细资料

removeGroup

void removeGroup(java.lang.String groupId)

删除群聊

参数:

groupId - -群ID

getGroup

IM.Group getGroup(java.lang.String groupId)

获取群信息

参数:

groupId - 群ID

返回:

-

getGroupTeams

java.util.List<java.util.Map<java.lang.String,java.lang.String>> getGroupTeams(java.lang.String groupId,
                                                                               java.lang.String userId)

获取群中团队信息

参数:

groupId - 群ID

userId - 用户ID，当用户ID为空时返回所有团队

返回:

-

saveGroup

boolean saveGroup(IM.Group group)

保存群信息，只保存内容不为空的属性

参数:

group - 群对象

返回:

- true：保存成功，false：保存失败

getGroupUsers

java.util.List<IM.User> getGroupUsers(java.lang.String groupId,
                                      int pageno,
                                      int pagesize)

获取群聊中的用户

参数:

groupId - 群ID

pageno - 页码，默认从第一页开始取

pagesize - 每页数量，默认为每页取20条数据

返回:

-

getGroupUserIds

java.util.List<java.lang.String> getGroupUserIds(java.lang.String groupId)

获取群聊中的用户ID

参数:

groupId - 群ID

返回:

-

getGroupUser

IM.User getGroupUser(java.lang.String groupId,
                     java.lang.String userId)

获取群内用户信息，如用户在群内的备注等

参数:

groupId - -群ID

userId - -群用户ID

返回:

-

changeGroupLeader

void changeGroupLeader(java.lang.String groupId,
                       java.lang.String userId)

更换群主

参数:

groupId - -群ID

userId - -新群主UserID

setGroupLeader

void setGroupLeader(java.lang.String groupId,
                    java.lang.String userId)

设置群主

参数:

groupId - -群ID

userId - -群主ID

getGroupLeaderId

java.lang.String getGroupLeaderId(java.lang.String groupId)

获取群主ID

参数:

groupId - 群ID

返回:

-

getGroupLeader

IM.User getGroupLeader(java.lang.String groupId)

获取群主信息

参数:

groupId - 群ID

返回:

-

getGroupAdminId

java.util.Set<java.lang.String> getGroupAdminId(java.lang.String groupId)

获取群管理员ID

参数:

groupId - 群ID

返回:

-

getGroupAdmin

java.util.List<IM.User> getGroupAdmin(java.lang.String groupId)

获取群管理员信息

参数:

groupId - 群ID

返回:

-

exitGroup

void exitGroup(java.lang.String groupId,
               java.lang.String... userId)

退出群或把某人移出群

参数:

groupId - -群ID

userId - -用户的userId

dissolveGroup

void dissolveGroup(java.lang.String groupId)

解散群

参数:

groupId - -群ID

addGroupAdmin

void addGroupAdmin(java.lang.String groupId,
                   java.lang.String... userId)

增加群管理员

参数:

groupId - -群ID

userId - -用户的userId

removeGroupAdmin

void removeGroupAdmin(java.lang.String groupId,
                      java.lang.String... userId)

移动群管理员

参数:

groupId - -群ID

userId - -用户的userId

setGroupAdmin

void setGroupAdmin(java.lang.String groupId,
                   java.util.Set<java.lang.String> userIds)

替换群管理员

参数:

groupId - -群ID

userIds - -用户的userId

addGroupUser

void addGroupUser(java.lang.String groupId,
                  java.lang.String... userId)

增加群成员

参数:

groupId - -群ID

userId - -用户的userId

getUser

IM.User getUser(java.lang.String userId)

获取单位用户信息

参数:

userId - 用户ID

返回:

-

getUsers

java.util.Map<java.lang.String,IM.User> getUsers(java.util.Set<java.lang.String> userIds)

获取多个用户信息

参数:

userIds - 多个用户ID

返回:

-

addGroupUser

void addGroupUser(java.lang.String groupId,
                  IM.User user)

增加群成员

参数:

groupId - 群ID

user - -群成员

removeGroupUser

void removeGroupUser(java.lang.String groupId,
                     java.lang.String... userId)

移动群成员

参数:

groupId - -群ID

userId - -用户的userId

setGroupUser

void setGroupUser(java.lang.String groupId,
                  java.util.Set<java.lang.String> userIds)

替换群成员

参数:

groupId - -群ID

userIds - -用户的userId

saveGroupUser

boolean saveGroupUser(java.lang.String groupId,
                      IM.User user)

保存群用户，只保存内容不为空的属性

参数:

groupId - 所在群ID

user - 群内的用户

返回:

- true：保存成功，false：保存失败

getCurUserId

java.lang.String getCurUserId()

获取当前登录用户的ID

返回:

-

getUserInfo

IM.User getUserInfo(java.lang.String userId)

获取用户信息，需要业务系统实现

参数:

userId - 用户ID

返回:

-

saveUserInfo

void saveUserInfo(IM.User user)

保存用户悠

参数:

user - -

addUserFriend

void addUserFriend(java.lang.String userId,
                   java.lang.String friendId)

增加好友，双方的好友列表中都会增加

参数:

userId - 当前用户ID

friendId - 好友用户ID

removeUserFriend

void removeUserFriend(java.lang.String userId,
                      java.lang.String... friendIds)

删除好友

参数:

userId - 当前用户ID

friendIds - 好友用户ID

getUserFriends

java.util.List<IM.User> getUserFriends(java.lang.String userId)

获取用户的好友列表

参数:

userId - 用户ID

返回:

-

getUserGroups

java.util.List<IM.Group> getUserGroups(java.lang.String userId)

获取用户所在分组列表

参数:

userId - 用户ID

返回:

-

saveMessage

void saveMessage(IM.Body body)

保存消息

参数:

body - -消息体

updateReadSingleLasttime

void updateReadSingleLasttime(java.lang.String userId,
                              java.lang.String toId)

更新单聊最后读取消息时间

参数:

userId - 当前用户ID

toId - -好友用户ID

updateReadGroupLasttime

void updateReadGroupLasttime(java.lang.String userId,
                             java.lang.String groupId)

更新群聊最后读取消息时间

参数:

userId - 当前用户ID

groupId - -群聊ID

pullNewMessage

java.util.List<IM.Body> pullNewMessage(java.lang.String userId)

拉取最新的新消息，主要提供给用户登录后一次性拉取最新的消息，只取最新100条

参数:

userId - -用户的userId

返回:

-

pullNewMessageNum

java.util.List<IM.NewMsgNum> pullNewMessageNum(java.lang.String userId)

拉取用户最新消息的总数量，上一次离线后收到的消息数量

参数:

userId - 用户ID

返回:

-

pullSingleMessage

java.util.List<IM.Body> pullSingleMessage(java.lang.String userId,
                                          java.lang.String toId,
                                          java.util.Date date,
                                          boolean isNext)

拉取单聊历史消息，根据日期按天拉取

参数:

userId - 当前用户ID

toId - 好友用户ID

date - 拉取消息的日期

isNext - 当前日期没有消息时是否自动获取上一天的消息，默认为true表示自动获取上一天的消息

返回:

-

pullGroupMessage

java.util.List<IM.Body> pullGroupMessage(java.lang.String userId,
                                         java.lang.String groupId,
                                         java.util.Date date,
                                         boolean isNext)

拉取聊聊历史消息，根据日期按天拉取

参数:

userId - 当前用户ID

groupId - 群聊ID

date - 拉取消息的日期

isNext - 当前日期没有消息时是否自动获取上一天的消息，默认为true表示自动获取上一天的消息

返回:

-

setTagByFriend

void setTagByFriend(java.lang.String userId,
                    java.lang.String friendId,
                    java.lang.String tagCode)

给好友加标签

参数:

userId - - 当前用户ID

friendId - - 当前用户的好友ID

tagCode - - 标签代码

getUserFriendsByTag

java.util.List<IM.User> getUserFriendsByTag(java.lang.String userId,
                                            java.lang.String tagCode)

根据标签获取用户的好友列表

参数:

userId - 用户ID

tagCode - - 标签代码

返回:

-

setTagByGroup

void setTagByGroup(java.lang.String userId,
                   java.lang.String groupId,
                   java.lang.String memberId,
                   java.lang.String tagCode)

给好友加标签

参数:

userId - - 当前用户ID

groupId - - 当前用户所在群ID

memberId - - 当前用户所在群中的成员ID（对应用户ID:userId）

tagCode - - 标签代码

getGroupUsersByTag

java.util.List<IM.User> getGroupUsersByTag(java.lang.String groupId,
                                           java.lang.String tagCode,
                                           int pageno,
                                           int pagesize)

根据标签获取群成员列表

参数:

groupId - 群ID

tagCode - - 标签代码

pageno - 页码，默认从第一页开始取

pagesize - 每页数量，默认为每页取20条数据

返回:

-

addGroupTeam

java.lang.String addGroupTeam(java.lang.String groupId,
                              java.util.Map<java.lang.String,java.lang.String> teamInfo)

在群中增加团队

参数:

groupId - 群ID

teamInfo - 团队信息

返回:

-返回团队ID

updateGroupTeam

void updateGroupTeam(java.lang.String groupId,
                     java.lang.String teamId,
                     java.util.Map<java.lang.String,java.lang.String> teamInfo)

修改团队信息

参数:

groupId - 群ID

teamId - 群ID

teamInfo - 团队信息

removeGroupTeam

void removeGroupTeam(java.lang.String groupId,
                     java.lang.String teamId)

删除团队

参数:

groupId - 群ID

teamId - 群ID

addGroupTeamUser

void addGroupTeamUser(java.lang.String groupId,
                      java.lang.String teamId,
                      java.util.Set<java.lang.String> userId)

增加团队成员

参数:

groupId - 群ID

teamId - 群ID

userId - 用户Id

getGroupTeamUser

java.util.List<IM.User> getGroupTeamUser(java.lang.String groupId,
                                         java.lang.String teamId)

获取团队成员

参数:

groupId - 群ID

teamId - 群ID

返回:

-返回团队用户

getGroupTeamUserId

java.util.Set<java.lang.String> getGroupTeamUserId(java.lang.String groupId,
                                                   java.lang.String teamId)

获取团队成员ID

参数:

groupId - 群ID

teamId - 群ID

返回:

-返回团队ID

removeGroupTeamUser

void removeGroupTeamUser(java.lang.String groupId,
                         java.lang.String teamId,
                         java.util.Set<java.lang.String> userId)

删除团队成员

参数:

groupId - 群ID

teamId - 群ID

userId - 用户Id

pullMessageByTempId

java.util.List<IM.Body> pullMessageByTempId(java.lang.String tempid,
                                            java.util.Date time,
                                            int pagesize)

根据tempid获取消息记录

参数:

tempid - 临时会话ID

time - 消息时间，指定从某个时间点开始向前查询，默认为空表示从最新的时间点开始向前查询

pagesize - 单次拉取的数据量，默认为20条

返回:

-

onLine

void onLine(IM.Oninfo oninfo)

上线事件

参数:

oninfo - 上线用户相关信息

offLine

void offLine(IM.Oninfo oninfo)

下线事件

参数:

oninfo - 下线用户相关信息

getOninfo

IM.Oninfo getOninfo(java.lang.String userId)

获取用户上线信息，包含上线时间与下线时间，不包括User

参数:

userId - 用户ID

返回:

用户上线信息Oninfo