消息接收
Update:
本文主要介绍 云上曲率即时通讯IM SDK的消息接收功能。
功能描述
云上IM SDK通过push
类型方法,将发送的消息通过服务端推送给接收者的客户端。因此开发者需要在初始化时,将接收消息的方法进行初始化。接收消息后,根据消息内容进行处理。
接口说明
接收文本消息
pushChat
接口用来P2P消息、群组消息和房间消息。
接口参数说明:
参数
类型
说明
conversationType
会话类型
包括P2P会话、群组会话和房间会话
immessage
消息内容
用户接收的文本消息内容
代码示例
default void pushChat(IMMessage imMessage, ConversationType conversationType){}
接收文件类消息
通过pushFile
接口可以接收图片、音频、语音、视频、文件等文件类型消息。
接口参数说明:
参数
类型
说明
conversationType
会话类型
包括P2P会话、群组会话和房间会话
immessage
消息内容
用户接收的文件类消息内容
代码示例
default void pushFile(IMMessage imMessage, ConversationType conversationType){}
接收群组类消息
当出现以下的群组操作时,相关用户会接收到服务端推送的消息:
- 通知类消息,不需要接收用户进行操作
- 请求类消息,用户接收到该类消息需要进行操作
用户接收的群组通知
通过pushgroupChange
,用户可以获取到以下几类通知消息:
- 用户加入群组
- 用户退出群组
- 用户解散群组
- 用户被踢出群组
接口参数说明:
参数
类型
说明
groupId
群组ID
用户所属群组
attrs
自定义参数
开发者可以配置业务信息
changeType
群组通知类型
类型说明:
0-加入群组 1-退出群组
2-解散群组 3-被踢出群组
代码示例
default void pushGroupChange(long groupId, String attrs, int changeType){}
申请入群通知
当有入群申请时,群组的群主和管理员会接收到申请入群通知。
接口参数说明:
参数
类型
说明
groupId
群组ID
群主或管理员接受到申请请求的群组
fromId
用户ID
申请入群的用户ID
extraMessage
文本信息
请求附带的申请信息
attrs
自定义参数
开发者可以配置业务信息
代码示例
default void pushApplyGroup(long fromUid, long groupId, String extraMessage, String attrs){}
申请入群结果通知
用户申请入群后,会接收到申请入群结果通知。
- 同意申请
- 拒绝申请
接口参数说明:
参数
类型
说明
groupId
群组ID
用户申请入群的群组ID
fromUid
用户ID
群主或管理员
attrs
自定义参数
开发者可以配置业务信息
代码示例
default void pushAgreeApplyGroup(long fromUid, long groupId, String attrs){}
default void pushRefuseApplyGroup(long fromUid, long groupId, String attrs){}
邀请入群通知
当群组用户发起邀请其他用户入群时,其他用户会接收到邀请入群通知。
接口参数说明:
参数
类型
说明
groupId
群组ID
邀请进入的群组
fromUid
用户ID
发出邀请的群组用户用户ID
extraMessage
文本信息
请求附带的申请信息
attrs
自定义参数
开发者可以配置业务信息
代码示例
default void pushInviteGroup(long fromUid, long groupId, String extraMessage, String attrs){}
邀请入群结果通知
当被邀请用户对邀请进行处理后,邀请者会接收到邀请入群结果通知。
- 同意邀请
- 拒绝邀请
接口参数说明:
参数
类型
说明
groupId
群组ID
用户申请入群的群组ID
fromUid
用户ID
群主或管理员
attrs
自定义参数
开发者可以配置业务信息
代码示例
default void pushAgreeInviteGroup(long fromUid, long groupId, String attrs){}
default void pushRefuseInviteGroup(long fromUid, long groupId, String attrs){}
群组成员变更通知
通过pushGroupMemberChanger
,群组用户可以获取到以下几类通知消息:
- 有用户加入群组
- 有用户退出群组
接口参数说明:
参数
类型
说明
groupId
群组ID
用户所属群组
userId
用户ID
发生变更的用户ID
changeType
群组成员通知类型
类型说明:
0-有用户加入群组 1-有用户退出群组
代码示例
default void pushGroupMemberChange(long groupId, long userId, int changeType){}
群组管理员变更通知
通过pushGroupManagerChanger
,群组用户可以获取到以下几类通知消息:
- 群组管理员新增
- 群组管理员
接口参数说明:
参数
类型
说明
gid
群组ID
用户所属群组
uids
用户ID
发生变更的用户ID
changeType
群组成员通知类型
类型说明:
0-新增管理员 1-删除管理员
代码示例
default void pushGroupManagerChange(long gid, List<Long> uids, int changeType){}
用户接收的群主变更通知
群组用户可以接收到所在群组的群主变更的通知。
接口参数说明:
参数
类型
说明
gid
群组ID
用户所属群组
oldLeader
用户ID
变更前的群主ID
newLeader
用户ID
变更后的群主ID
代码示例
default void pushGroupLeaderChange(long gid, long oldLeader, long newLeader){}
接收房间类消息
接收好友类消息
当出现以下的好友操作时,相关用户会接收到服务端推送的消息:
- 通知类消息,不需要用户进行操作
- 请求类消息,用户接收到该类消息需要进行操作
好友申请通知
当有好友申请时,用户会接收到好友申请通知。
接口参数说明:
参数
类型
说明
fromUid
用户ID
申请好友的用户ID
extraMessage
文本信息
请求附带的申请信息
attrs
自定义参数
开发者可以配置业务信息
代码示例
default void pushAddFriend(long fromUid, String extraMessage, String attrs){}
好友申请结果通知
当用户进行好友申请处理后,申请者会接收到好友申请结果通知。
- 同意成为好友
- 拒绝成为好友
接口参数说明:
参数
类型
说明
userId
用户ID
被申请好友用户
attrs
自定义参数
开发者可以配置业务信息
代码示例
default void pushAgreeApplyFriend(long userId, String attrs){}
default void pushRefuseApplyFriend(long userId, String attrs){}
好友关系变更通知
用户在进行好友通过之后,好友关系的双方均会接收到好友关系变更通知。
接口参数说明:
参数
类型
说明
userId
用户ID
好友关系的对方用户ID
attrs
自定义参数
开发者可以配置业务信息
代码示例
- Android
default void pushEstablishFriend(long userId, String attrs){}
本文主要介绍 云上曲率即时通讯IM SDK的消息接收功能。
功能描述
云上IM SDK通过push
类型方法,将发送的消息通过服务端推送给接收者的客户端。因此开发者需要在初始化时,将接收消息的方法进行初始化。接收消息后,根据消息内容进行处理。
接口说明
接收文本消息
pushChat
接口用来P2P消息、群组消息和房间消息。
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
conversationType | 会话类型 | 包括P2P会话、群组会话和房间会话 |
immessage | 消息内容 | 用户接收的文本消息内容 |
代码示例
default void pushChat(IMMessage imMessage, ConversationType conversationType){}
接收文件类消息
通过pushFile
接口可以接收图片、音频、语音、视频、文件等文件类型消息。
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
conversationType | 会话类型 | 包括P2P会话、群组会话和房间会话 |
immessage | 消息内容 | 用户接收的文件类消息内容 |
代码示例
default void pushFile(IMMessage imMessage, ConversationType conversationType){}
接收群组类消息
当出现以下的群组操作时,相关用户会接收到服务端推送的消息:
- 通知类消息,不需要接收用户进行操作
- 请求类消息,用户接收到该类消息需要进行操作
用户接收的群组通知
通过pushgroupChange
,用户可以获取到以下几类通知消息:
- 用户加入群组
- 用户退出群组
- 用户解散群组
- 用户被踢出群组
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
groupId | 群组ID | 用户所属群组 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
changeType | 群组通知类型 | 类型说明: 0-加入群组 1-退出群组 2-解散群组 3-被踢出群组 |
代码示例
default void pushGroupChange(long groupId, String attrs, int changeType){}
申请入群通知
当有入群申请时,群组的群主和管理员会接收到申请入群通知。
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
groupId | 群组ID | 群主或管理员接受到申请请求的群组 |
fromId | 用户ID | 申请入群的用户ID |
extraMessage | 文本信息 | 请求附带的申请信息 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
default void pushApplyGroup(long fromUid, long groupId, String extraMessage, String attrs){}
申请入群结果通知
用户申请入群后,会接收到申请入群结果通知。
- 同意申请
- 拒绝申请
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
groupId | 群组ID | 用户申请入群的群组ID |
fromUid | 用户ID | 群主或管理员 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
default void pushAgreeApplyGroup(long fromUid, long groupId, String attrs){}
default void pushRefuseApplyGroup(long fromUid, long groupId, String attrs){}
邀请入群通知
当群组用户发起邀请其他用户入群时,其他用户会接收到邀请入群通知。
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
groupId | 群组ID | 邀请进入的群组 |
fromUid | 用户ID | 发出邀请的群组用户用户ID |
extraMessage | 文本信息 | 请求附带的申请信息 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
default void pushInviteGroup(long fromUid, long groupId, String extraMessage, String attrs){}
邀请入群结果通知
当被邀请用户对邀请进行处理后,邀请者会接收到邀请入群结果通知。
- 同意邀请
- 拒绝邀请
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
groupId | 群组ID | 用户申请入群的群组ID |
fromUid | 用户ID | 群主或管理员 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
default void pushAgreeInviteGroup(long fromUid, long groupId, String attrs){}
default void pushRefuseInviteGroup(long fromUid, long groupId, String attrs){}
群组成员变更通知
通过pushGroupMemberChanger
,群组用户可以获取到以下几类通知消息:
- 有用户加入群组
- 有用户退出群组
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
groupId | 群组ID | 用户所属群组 |
userId | 用户ID | 发生变更的用户ID |
changeType | 群组成员通知类型 | 类型说明: 0-有用户加入群组 1-有用户退出群组 |
代码示例
default void pushGroupMemberChange(long groupId, long userId, int changeType){}
群组管理员变更通知
通过pushGroupManagerChanger
,群组用户可以获取到以下几类通知消息:
- 群组管理员新增
- 群组管理员
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
gid | 群组ID | 用户所属群组 |
uids | 用户ID | 发生变更的用户ID |
changeType | 群组成员通知类型 | 类型说明: 0-新增管理员 1-删除管理员 |
代码示例
default void pushGroupManagerChange(long gid, List<Long> uids, int changeType){}
用户接收的群主变更通知
群组用户可以接收到所在群组的群主变更的通知。 接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
gid | 群组ID | 用户所属群组 |
oldLeader | 用户ID | 变更前的群主ID |
newLeader | 用户ID | 变更后的群主ID |
代码示例
default void pushGroupLeaderChange(long gid, long oldLeader, long newLeader){}
接收房间类消息
接收好友类消息
当出现以下的好友操作时,相关用户会接收到服务端推送的消息:
- 通知类消息,不需要用户进行操作
- 请求类消息,用户接收到该类消息需要进行操作
好友申请通知
当有好友申请时,用户会接收到好友申请通知。
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
fromUid | 用户ID | 申请好友的用户ID |
extraMessage | 文本信息 | 请求附带的申请信息 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
default void pushAddFriend(long fromUid, String extraMessage, String attrs){}
好友申请结果通知
当用户进行好友申请处理后,申请者会接收到好友申请结果通知。
- 同意成为好友
- 拒绝成为好友
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
userId | 用户ID | 被申请好友用户 |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
default void pushAgreeApplyFriend(long userId, String attrs){}
default void pushRefuseApplyFriend(long userId, String attrs){}
好友关系变更通知
用户在进行好友通过之后,好友关系的双方均会接收到好友关系变更通知。
接口参数说明:
参数 | 类型 | 说明 |
---|---|---|
userId | 用户ID | 好友关系的对方用户ID |
attrs | 自定义参数 | 开发者可以配置业务信息 |
代码示例
- Android
default void pushEstablishFriend(long userId, String attrs){}