IM 即时通讯
iOS
产品介绍
简介
主要功能
产品优势
功能介绍
帐号集成与登录
基础消息功能
群组功能
聊天室功能
聊天室标签功能
圈组功能
多端登录与互踢策略
质量数据监控台
海外数据中心
IM平滑迁移方案
接口及业务限制
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
跑通圈组 Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
组件导入
初始化与登录
界面跳转
自定义用户信息
会话列表相关
集成会话列表界面
自定义会话列表 UI
会话列表 API 概览
会话消息相关
集成会话消息界面
实现地理位置消息功能
实现音视频通话
实现自定义消息收发
自定义会话消息 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录 UI
通讯录 API 概览
IM UIKit API 概览
不含 UI 集成
集成 SDK
初始化
登录相关
登录 IM
多端登录与互踢
登出 IM
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
NOS 资源场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
本地消息插入
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
离线推送
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
圈组概述
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
实时互动频道
频道分组
频道分组黑白名单
频道未读数管理
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
频道分组身份组
用户定制权限
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
会话消息回复(Thread)
圈组快捷评论
圈组消息缓存
圈组消息搜索
查询历史消息
查询@我的消息
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组离线推送
圈组内容审核
圈组第三方回调
圈组相关抄送
圈组各端接口命名差异
反垃圾
聊天扩展
其他
最佳实践
IM 登录最佳实践
聊天室重要消息投递
参考文档
iOS PushKit 配置
iOS苹果推送配置
API 参考
iOS SDK API
iOS SDK 状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置客户端应用标识
常见问题
FAQ
错题集
iOS 推送问题排查
服务协议

频道分组身份组

更新时间: 2022/12/13 15:13:39

本文以多用户交互的典型场景为例,介绍在频道分组维度对用户进行权限控制的实现方法和示例代码。

技术原理

网易云信即时通讯 NIM iOS SDK 的NIMQChatRoleManager Protocol提供管理频道分组身份组的相关方法(如addChannelCategoryRole),助您快速实现在频道分组维度对不同用户的权限控制。 调用管理频道分组身份组的相关方法,需要管理角色的权限(NIMQChatPermissionType枚举下的NINQChatPermissionTypeManageRole)。

新创建的频道分组身份组的权限设置,默认继承自指定的服务器身份组(通过服务器身份组的 ID 指定)。如果需要在频道分组维度设置和服务器维度有区分的用户权限,需在创建频道分组身份组后调用updateChannelCategoryRole方法对权限做更改;或者调用addChannelCategoryMemberRole方法创建成员在频道分组的定制权限,再调用updateChannelCategoryMemberRole方法设置具体的权限。

频道分组身份组.png

实现方法

本节以服务器所有者和服务器成员的交互为例(服务器成员仅被授予管理角色权限的场景),介绍服务器成员创建频道分组身份组的实现流程。

  • 服务器所有者可以在创建服务器和频道分组后直接调用addChannelCategoryRole方法创建频道分组身份组。
  • 创建后, 用户可更新、删除、查询频道分组身份组,相关方法见本文的API 参考
  • 服务器成员创建频道分组某人的定制权限的实现,可参考本场景的流程。

前提条件

已创建服务器。

实现流程

  1. 服务器所有者调用addServerRoleMembers方法,将服务器成员加入身份组。

  2. 服务器所有者调用updateServerRole方法,授予该身份组管理角色的权限(NINQChatPermissionTypeManageRole)。

    结果

    服务器成员将拥有管理角色的权限。

  3. 服务器所有者调用createChannelCategory方法,创建频道分组。

  4. 如果创建的是私密频道分组,服务器所有者需调用updateChannelCategoryBlackWhiteMembers方法,将该成员加入频道分组白名单。

    如果创建的是公开频道分组,请跳过这一步。

  5. 服务器成员调用getServerRoles方法获取频道分组所在的服务器的目标身份组 ID(serverRoleId)。

    如果服务器成员在服务器维度没有管理角色的权限,但在频道分组维度有该权限时,调用getServerRoles方法时传入频道分组 ID(categoryId)才能查询服务器的身份组列表,进而获取目标服务器身份组 ID。

  6. 服务器成员调用addChannelCategoryRole方法,创建频道分组身份组。

    入参
    类型
    是否必传 说明
    serverId unsinged long long 频道分组所在的服务器的 ID
    serverRoleId unsinged long long 服务器身份组 ID。生成的频道分组身份组从该服务器身份组继承,以此 ID 作为频道身份组的parentRoleId
    categoryId unsinged long long 频道分组 ID

    服务器成员可通过圈组的内置系统通知(NIMQChatSystemNotificationTypeCreateChannelCategory)获知categoryId。如服务器成员人数超过目前默认的阈值 2,000(可联系商务经理调整),成员需调用subscribeServer方法订阅服务器才能接收到该系统通知。服务器成员人数在阈值内,则不需要订阅服务器也能接收到。

API 调用时序图

uml diagram

示例代码

//*********************  1.将服务器成员加入身份组  *********************//
//服务器id
unsigned long long serverId = 18999;
//身份组id
unsigned long long roleId = 211456;
//需要加入服务器的用户
NSString *accId = @"test1";
NIMQChatAddServerRoleMembersParam *addServerRoleMembersParam = [[NIMQChatAddServerRoleMembersParam alloc] init];
addServerRoleMembersParam.serverId = serverId;
addServerRoleMembersParam.roleId = roleId;
addServerRoleMembersParam.accountArray = @[accId];
[[NIMSDK sharedSDK].qchatRoleManager addServerRoleMembers:addServerRoleMembersParam completion:^(NSError * _Nullable error, NIMQChatAddServerRoleMembersResult * _Nullable result) {
    if (!error) {
        // do something when success
    }
}];
//*********************  2.授予该身份组管理频道权限  *********************//
NIMQChatUpdateServerRoleParam *updateServerRoleParam = [[NIMQChatUpdateServerRoleParam alloc] init];
updateServerRoleParam.roleId = roleId;
updateServerRoleParam.serverId = serverId;
NIMQChatPermissionStatusInfo *permission = [[NIMQChatPermissionStatusInfo alloc] init];
permission.type = NIMQChatPermissionTypeManageChannel;
permission.status = NIMQChatPermissionStatusAllow;
updateServerRoleParam.commands = @[permission];
[[NIMSDK sharedSDK].qchatRoleManager updateServerRole:updateServerRoleParam completion:^(NSError * _Nullable error, NIMQChatServerRole * _Nullable result) {
    if (!error) {
        // do something when success
    }
}];
//*********************  3.创建频道分组  *********************//
NIMQChatCreateChannelCategoryParam *createChannelCategoryParam = [[NIMQChatCreateChannelCategoryParam alloc] init];
createChannelCategoryParam.serverId = serverId;
createChannelCategoryParam.name = @"分组名";
createChannelCategoryParam.viewMode = NIMQChatChannelViewModePrivate;
[[NIMSDK sharedSDK].qchatChannelManager createChannelCategory:createChannelCategoryParam completion:^(NSError * _Nullable error, NIMQChatChannelCategory * _Nullable result) {
    if (!error) {
        // do something when success
    }
}];

//*********************  4.将成员加入频道分组白名单  *********************//
unsigned long long categoryId = 78900;
NIMQChatUpdateChannelCategoryBlackWhiteMembersParam *updateCategoryBWMembersParam = [[NIMQChatUpdateChannelCategoryBlackWhiteMembersParam alloc] init];
updateCategoryBWMembersParam.serverId = serverId;
updateCategoryBWMembersParam.categoryId = categoryId;
updateCategoryBWMembersParam.type = NIMQChatChannelMemberRoleTypeWhite;
updateCategoryBWMembersParam.opeType = NIMQChatChannelMemberRoleOpeTypeAdd;
[[NIMSDK sharedSDK].qchatChannelManager updateChannelCategoryBlackWhiteMembers:updateCategoryBWMembersParam completion:^(NSError * _Nullable error) {
    //code
}];

//*********************  5.查询服务器下身份组列表  *********************//
NIMQChatGetServerRolesParam *getServerRoleParam = [[NIMQChatGetServerRolesParam alloc] init];
getServerRoleParam.serverId = serverId;
getServerRoleParam.limit = 100;
getServerRoleParam.priority = 0;
getServerRoleParam.categoryId = categoryId;
[[NIMSDK sharedSDK].qchatRoleManager getServerRoles:getServerRoleParam completion:^(NSError * _Nullable error, NIMQChatGetServerRolesResult * _Nullable result) {
    //code
}];

//*********************  6.创建频道分组身份组  *********************//
NIMQChatAddChannelCategoryRoleParam *addCategoryRoleParam = [[NIMQChatAddChannelCategoryRoleParam alloc] init];
addCategoryRoleParam.serverId = serverId;
addCategoryRoleParam.parentRoleId = roleId;
addCategoryRoleParam.categoryId = categoryId;
[[NIMSDK sharedSDK].qchatRoleManager addChannelCategoryRole:addCategoryRoleParam completion:^(NSError * _Nullable error, NIMQChatChannelCategoryRole * _Nullable result) {
    //code
}];

API 参考

API
说明
addChannelCategoryRole 创建频道分组身份组
removeChannelCategoryRole 删除频道分组身份组
updateChannelCategoryRole 更新频道分组身份组。设置频道分组身份组的权限,需调用该方法
getChannelCategoryRoles 查询频道分组身份组信息
addChannelCategoryMemberRole 创建频道分组某人的定制权限,创建后还需调用updateChannelCategoryMemberRole才能授予某人权限
removeChannelCategoryMemberRole 删除频道分组某人的定制权限
updateChannelCategoryMemberRole 修改频道分组某人的定制权限。创建某人定制权限后,需再调用本方法才能授予某人权限
getChannelCategoryMemberRoles 查询频道分组某人的定制权限
此文档是否对你有帮助?
有帮助
我要吐槽
  • 技术原理
  • 实现方法
  • 前提条件
  • 实现流程
  • API 调用时序图
  • 示例代码
  • API 参考