NIM PC Cross Platform SDK
nim_qchat_role_def.h File Reference

圈组身份组相关数据结构声明 More...

#include "nim_qchat_member_def.h"
#include "nim_qchat_public_def.h"
#include <map>

Go to the source code of this file.

Classes

struct  NIMQChatPermissionGroup
 
struct  NIMQChatRoleMemberInfo
 
struct  NIMQChatServerRoleInfo
 
struct  NIMQChatChannelRoleInfo
 
struct  NIMQChatChannelCategoryRoleInfo
 
struct  NIMQChatRoleInfo
 
struct  NIMQChatMemberRoleInfo
 
struct  NIMQChatChannelCategoryMemberRoleInfo
 
struct  NIMQChatCreateServerRoleResp
 
struct  NIMQChatUpdateServerRoleResp
 
struct  NIMQChatGetServerRolesResp
 
struct  NIMQChatAddMembersToServerRoleResp
 
struct  NIMQChatGetMembersFromServerRoleResp
 
struct  NIMQChatAddChannelRoleResp
 
struct  NIMQChatGetChannelRolesResp
 
struct  NIMQChatAddMemberRoleResp
 
struct  NIMQChatAddChannelCategoryMemberRoleResp
 
struct  NIMQChatGetMemberRolesResp
 
struct  NIMQChatGetChannelCategoryMemberRolesPageResp
 
struct  NIMQChatRoleInfoOfMember
 
struct  NIMQChatGetServerRolesByMemberIdsResp
 
struct  NIMQChatGetExistingAccidsOfMemberRolesResp
 
struct  NIMQChatCheckPermissionResp
 
struct  NIMQChatCheckPermissionsResp
 
struct  NIMQChatCreateServerRoleParam
 
struct  NIMQChatUpdateServerRoleParam
 
struct  NIMQChatBatchUpdateServeRolePriorityGroup
 
struct  NIMQChatBatchUpdateServerRolePrioritiesParam
 
struct  NIMQChatDeleteServerRoleParam
 
struct  NIMQChatGetServerRolesParam
 
struct  NIMQChatAddMembersToServerRoleParam
 
struct  NIMQChatGetMembersFromServerRoleParam
 
struct  NIMQChatAddChannelRoleParam
 
struct  NIMQChatUpdateChannelRoleParam
 
struct  NIMQChatRemoveChannelRoleParam
 
struct  NIMQChatGetChannelRolesParam
 
struct  NIMQChatAddMemberRoleParam
 
struct  NIMQChatUpdateMemberRoleParam
 
struct  NIMQChatRemoveMemberRoleParam
 
struct  NIMQChatGetMemberRolesParam
 
struct  NIMQChatGetServerRolesByMembersIdParam
 
struct  NIMQChatGetServerRolesByMemberIdsParam
 
struct  NIMQChatGetExistingRolesInChannelParam
 
struct  NIMQChatGetExistingAccidsOfMemberRolesParam
 
struct  NIMQChatGetExistingAccidsInServerRoleParam
 
struct  NIMQChatCheckPermissionParam
 
struct  NIMQChatCheckPermissionsParam
 
struct  NIMQChatAddChannelCategoryRoleParam
 
struct  NIMQChatUpdateChannelCategoryRoleParam
 
struct  NIMQChatRemoveChannelCategoryRoleParam
 
struct  NIMQChatGetChannelCategoryRolesPageParam
 
struct  NIMQChatAddChannelCategoryMemberRoleParam
 
struct  NIMQChatUpdateChannelCategoryMemberRoleParam
 
struct  NIMQChatRemoveChannelCategoryMemberRoleParam
 
struct  NIMQChatGetChannelCategoryMemberRolesPageParam
 

Typedefs

typedef NIMQChatBaseResp NIMQChatDeleteServerRoleResp
 
typedef char * QChatMemberAccountId
 
typedef NIMQChatAddMembersToServerRoleResp NIMQChatRemoveMembersFromServerRoleResp
 
typedef NIMQChatAddChannelRoleResp NIMQChatUpdateChannelRoleResp
 
typedef NIMQChatAddChannelRoleResp NIMQChatAddChannelCategoryRoleResp
 
typedef NIMQChatAddChannelRoleResp NIMQChatUpdateChannelCategoryRoleResp
 
typedef NIMQChatBaseResp NIMQChatRemoveChannelRoleResp
 
typedef NIMQChatBaseResp NIMQChatRemoveChannelCategoryRoleResp
 
typedef NIMQChatGetChannelRolesResp NIMQChatGetChannelCategoryRolesPageResp
 
typedef NIMQChatAddMemberRoleResp NIMQChatUpdateMemberRoleResp
 
typedef NIMQChatAddChannelCategoryMemberRoleResp NIMQChatUpdateChannelCategoryMemberRoleResp
 
typedef NIMQChatBaseResp NIMQChatRemoveMemberRoleResp
 
typedef NIMQChatBaseResp NIMQChatRemoveChannelCategoryMemberRoleResp
 
typedef NIMQChatGetServerRolesResp NIMQChatGetServerRolesByMembersIdResp
 
typedef NIMQChatGetChannelRolesResp NIMQChatGetExistingRolesInChannelResp
 
typedef NIMQChatGetServerRolesResp NIMQChatUpdateServerRolePrioritiesResp
 
typedef NIMQChatGetExistingAccidsOfMemberRolesResp NIMQChatGetExistingAccidsInServerRoleResp
 
typedef void(* nim_qchat_role_server_create_cb_func) (const NIMQChatCreateServerRoleResp *resp)
 创建服务器身份组回调
 
typedef void(* nim_qchat_role_server_update_cb_func) (const NIMQChatUpdateServerRoleResp *resp)
 更新服务器身份组回调
 
typedef void(* nim_qchat_role_server_batch_update_priorities_cb_func) (const NIMQChatUpdateServerRolePrioritiesResp *resp)
 批量服务器身份组权限回调
 
typedef void(* nim_qchat_role_server_delete_cb_func) (const NIMQChatDeleteServerRoleResp *resp)
 删除服务器身份组回调
 
typedef void(* nim_qchat_role_server_get_list_cb_func) (const NIMQChatGetServerRolesResp *resp)
 查询服务器身份组回调
 
typedef void(* nim_qchat_role_server_add_member_cb_func) (const NIMQChatAddMembersToServerRoleResp *resp)
 服务器身份组添加成员回调
 
typedef void(* nim_qchat_role_server_remove_members_cb_func) (const NIMQChatRemoveMembersFromServerRoleResp *resp)
 服务器身份组删除成员回调
 
typedef void(* nim_qchat_role_server_get_members_cb_func) (const NIMQChatGetMembersFromServerRoleResp *resp)
 服务器身份组查询成员回调
 
typedef void(* nim_qchat_role_channel_add_cb_func) (const NIMQChatAddChannelRoleResp *resp)
 创建频道身份组回调
 
typedef void(* nim_qchat_role_channel_update_cb_func) (const NIMQChatUpdateChannelRoleResp *resp)
 更新频道身份组回调
 
typedef void(* nim_qchat_role_channel_remove_cb_func) (const NIMQChatRemoveChannelRoleResp *resp)
 删除频道身份组回调
 
typedef void(* nim_qchat_role_channel_get_list_cb_func) (const NIMQChatGetChannelRolesResp *resp)
 查询频道身份组回调
 
typedef void(* nim_qchat_role_member_add_cb_func) (const NIMQChatAddMemberRoleResp *resp)
 创建频道个人定制权限回调
 
typedef void(* nim_qchat_role_member_update_cb_func) (const NIMQChatUpdateMemberRoleResp *resp)
 更新频道个人定制权限回调
 
typedef void(* nim_qchat_role_member_remove_cb_func) (const NIMQChatRemoveMemberRoleResp *resp)
 删除频道个人定制权限回调
 
typedef void(* nim_qchat_role_member_get_list_cb_func) (const NIMQChatGetMemberRolesResp *resp)
 查询频道个人定制权限回调
 
typedef void(* nim_qchat_role_member_roles_cb_func) (const NIMQChatGetServerRolesByMembersIdResp *resp)
 根据ACCID查询服务器身份组回调
 
typedef void(* nim_qchat_role_member_get_roles_by_ids_cb_func) (const NIMQChatGetServerRolesByMemberIdsResp *resp)
 查询一批查询一批accids的服务器的自定义身份组列表首页
 
typedef void(* nim_qchat_role_get_existing_roles_in_channel_cb_func) (const NIMQChatGetExistingRolesInChannelResp *resp)
 查询一批服务器身份组在频道中的身份组信息,只会返回存在的
 
typedef void(* nim_qhcat_role_get_existing_accids_of_member_roles_cb_func) (const NIMQChatGetExistingAccidsOfMemberRolesResp *resp)
 查询一批accids在频道中配置的权限,只会返回存在的
 
typedef void(* nim_qchat_role_get_accids_in_server_role_cb_func) (const NIMQChatGetExistingAccidsInServerRoleResp *resp)
 查询一批accids是否在某个服务器身份组,返回在的成员信息
 
typedef void(* nim_qchat_role_check_permission_cb_func) (const NIMQChatCheckPermissionResp *resp)
 查询自己是否拥有某个权限
 
typedef void(* nim_qchat_role_check_permissions_cb_func) (const NIMQChatCheckPermissionsResp *resp)
 批量查询自己的权限
 
typedef void(* nim_qchat_role_channel_category_add_cb_func) (const NIMQChatAddChannelCategoryRoleResp *resp)
 创建频道分组身份组回调
 
typedef void(* nim_qchat_role_channel_category_update_cb_func) (const NIMQChatUpdateChannelCategoryRoleResp *resp)
 更新频道分组身份组回调
 
typedef void(* nim_qchat_role_channel_category_remove_cb_func) (const NIMQChatRemoveChannelCategoryRoleResp *resp)
 删除频道分组身份组回调
 
typedef void(* nim_qchat_role_channel_category_get_list_page_cb_func) (const NIMQChatGetChannelCategoryRolesPageResp *resp)
 查询频道分组身份组回调
 
typedef void(* nim_qchat_role_channel_category_member_role_add_cb_func) (const NIMQChatAddChannelCategoryMemberRoleResp *resp)
 创建频道分组个人定制权限回调
 
typedef void(* nim_qchat_role_channel_category_member_role_update_cb_func) (const NIMQChatUpdateChannelCategoryMemberRoleResp *resp)
 更新频道分组个人定制权限回调
 
typedef void(* nim_qchat_role_channel_category_member_role_remove_cb_func) (const NIMQChatRemoveChannelCategoryMemberRoleResp *resp)
 删除频道分组个人定制权限回调
 
typedef void(* nim_qchat_role_channel_category_member_role_get_list_page_cb_func) (const NIMQChatGetChannelCategoryMemberRolesPageResp *resp)
 查询频道分组个人定制权限回调
 
typedef NIMQChatAddMembersToServerRoleParam NIMQChatRemoveMembersFromServerRoleParam
 

Enumerations

enum  NIMQChatPermissions {
  kPermissionManageServer = 1 , kPermissionManageChannel , kPermissionManageRole , kPermissionSendMessage ,
  kPermissionUpdateMyInfo , kPermissionIviteMember , kPermissionKickMember , kPermissionUpdateMemberInfo ,
  kPermissionRevokeMemberMessage , kPermissionDeleteMemberMessage , kPermissionAtMember , kPermissionAtAll ,
  kPermissionManageBlackWhiteList , kPermissionBanServerMember , kPermissionRTCConnect , kPermissionRTCDisconnectOther ,
  kPermissionRTCOpenMic , kPermissionRTCOpenCamera , kPermissionRTCOpenMuteOthersMic , kPermissionRTCOpenMuteOthersCamera ,
  kPermissionRTCOpenMuteAllMic , kPermissionRTCOpenMuteAllCamera , kPermissionRTCOpenScreenShare , kPermissionRTCCloseOthersScreenShare ,
  kPermissionServerHandleApply , kPermissionGetServerInviteApplyRecords , kPermissionAtRole
}
 
enum  NIMQChatPermissionsOption { kPermissionSwitchDeny = -1 , kPermissionSwitchExtend , kPermissionSwitchAllow }
 
enum  NIMQChatRoleType { kRoleTypeUnkonwn = 0 , kRoleTypeEveryone = 1 , kRoleTypeCustom }
 

Detailed Description

圈组身份组相关数据结构声明

Author
NetEase Yunxin
Version
0.1
Date
2022-01-17

Enumeration Type Documentation

◆ NIMQChatPermissions

Enumerator
kPermissionManageServer 

管理服务器,Server

kPermissionManageChannel 

管理频道,Server/Channel

kPermissionManageRole 

管理角色,Server/Channel

kPermissionSendMessage 

发送消息,Server/Channel

kPermissionUpdateMyInfo 

修改自己信息,Server

kPermissionIviteMember 

邀请他人,Server

kPermissionKickMember 

踢除他人,Server

kPermissionUpdateMemberInfo 

修改他人信息,Server

kPermissionRevokeMemberMessage 

撤回他人信息,Server/Channel

kPermissionDeleteMemberMessage 

删除他人消息,Server/Channel

kPermissionAtMember 

@ 他人,Server/Channel

kPermissionAtAll 

@ 所有人,Server/Channel

kPermissionManageBlackWhiteList 

管理白/黑名单,Server/Channel

kPermissionBanServerMember 

封禁他人,Server

kPermissionRTCConnect 

RTC频道: 连接的权限,Server/Channel.

kPermissionRTCDisconnectOther 

RTC频道: 断开他人连接的权限,Server/Channel.

kPermissionRTCOpenMic 

RTC频道: 开启自己麦克风的权限,Server/Channel.

kPermissionRTCOpenCamera 

RTC频道: 开启自己摄像头的权限,Server/Channel.

kPermissionRTCOpenMuteOthersMic 

RTC频道: 禁用/解禁他人麦克风的权限,Server/Channel.

kPermissionRTCOpenMuteOthersCamera 

RTC频道: 禁用/解禁他人摄像头的权限,Server/Channel.

kPermissionRTCOpenMuteAllMic 

RTC频道: 禁用/解禁全员麦克风的权限,Server/Channel.

kPermissionRTCOpenMuteAllCamera 

RTC频道: 禁用/解禁全员摄像头的权限,Server/Channel.

kPermissionRTCOpenScreenShare 

RTC频道: 打开自己共享屏幕的权限,Server/Channel.

kPermissionRTCCloseOthersScreenShare 

RTC频道: 关闭他人共享屏幕的权限,Server/Channel.

kPermissionServerHandleApply 

服务器申请处理权限,Server

kPermissionGetServerInviteApplyRecords 

申请邀请历史查看权限,有这个权限才可以查询server级别的申请/邀请记录,Server

kPermissionAtRole 

@ 身份组的权限,Server/Channel

◆ NIMQChatPermissionsOption

Enumerator
kPermissionSwitchDeny 

拒绝

kPermissionSwitchExtend 

继承

kPermissionSwitchAllow 

允许

◆ NIMQChatRoleType

Enumerator
kRoleTypeUnkonwn 

未知

kRoleTypeEveryone 

默认 Everyone 身份组

kRoleTypeCustom 

自定义身份组