NIM PC Cross Platform SDK
nim_qchat_role.h File Reference

圈组身份组相关接口定义 More...

#include "nim_qchat_defines/nim_qchat_role_def.h"
#include "public_defines.h"

Go to the source code of this file.

Functions

NIM_SDK_DLL_API void nim_qchat_role_server_create (const NIMQChatCreateServerRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_server_update (const NIMQChatUpdateServerRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_server_batch_update_priorities (const NIMQChatBatchUpdateServerRolePrioritiesParam &param)
 批量更新服务器身份组信息 More...
 
NIM_SDK_DLL_API void nim_qchat_role_server_delete (const NIMQChatDeleteServerRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_server_get_list (const NIMQChatGetServerRolesParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_server_add_members (const NIMQChatAddMembersToServerRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_server_remove_members (const NIMQChatRemoveMembersFromServerRoleParam &param)
 将部分成员从服务器指定身份组中移除 More...
 
NIM_SDK_DLL_API void nim_qchat_role_server_get_members (const NIMQChatGetMembersFromServerRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_channel_add (const NIMQChatAddChannelRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_channel_update (const NIMQChatUpdateChannelRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_channel_remove (const NIMQChatRemoveChannelRoleParam &param)
 
NIM_SDK_DLL_API void nim_qchat_role_channel_get_list (const NIMQChatGetChannelRolesParam &param)
 分页获取指定频道的身份组信息 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_add (const NIMQChatAddMemberRoleParam &param)
 定制指定成员在频道中的权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_update (const NIMQChatUpdateMemberRoleParam &param)
 更新指定成员在频道中的权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_remove (const NIMQChatRemoveMemberRoleParam &param)
 移除指定成员在频道中的定制权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_get_list (const NIMQChatGetMemberRolesParam &param)
 分页查询指定频道下针对成员的定制权限列表 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_get_server_roles (const NIMQChatGetServerRolesByMembersIdParam &param)
 通过用户账号查询自定义身份组列表 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_get_roles_by_member_ids (const NIMQChatGetServerRolesByMemberIdsParam &param)
 通过一组 accid 列表查询该列表下所有人的所有已加入的身份组信息 More...
 
NIM_SDK_DLL_API void nim_qchat_role_channel_get_existing_roles (const NIMQChatGetExistingRolesInChannelParam &param)
 获取指定频道下已存在的身份组列表 More...
 
NIM_SDK_DLL_API void nim_qchat_role_member_get_existing_roles (const NIMQChatGetExistingAccidsOfMemberRolesParam &param)
 批量获取指定频道下一批用户的定制权限信息,只会返回已存在的个人定制权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_server_get_existing_members (const NIMQChatGetExistingAccidsInServerRoleParam &param)
 查询服务器某身份组是否包含指定成员 More...
 
NIM_SDK_DLL_API void nim_qchat_role_check_permission (const NIMQChatCheckPermissionParam &param)
 查询当前登录用户是否拥有特定权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_check_permissions (const NIMQChatCheckPermissionsParam &param)
 批量查询当前登录用户是否拥有特定权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_add_channel_category_role (const NIMQChatAddChannelCategoryRoleParam &param)
 添加一个身份组到频道分组 More...
 
NIM_SDK_DLL_API void nim_qchat_role_remove_channel_category_role (const NIMQChatRemoveChannelCategoryRoleParam &param)
 从频道分组中移除一个身份组 More...
 
NIM_SDK_DLL_API void nim_qchat_role_update_channel_category_role (const NIMQChatUpdateChannelCategoryRoleParam &param)
 更新频道分组中的身份组信息 More...
 
NIM_SDK_DLL_API void nim_qchat_role_get_channel_category_roles_page (const NIMQChatGetChannelCategoryRolesPageParam &param)
 分页获取频道分组下的身份组列表 More...
 
NIM_SDK_DLL_API void nim_qchat_role_add_channel_category_member_role (const NIMQChatAddChannelCategoryMemberRoleParam &param)
 定制指定成员在频道分组中的权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_remove_channel_category_member_role (const NIMQChatRemoveChannelCategoryMemberRoleParam &param)
 取消指定成员在频道分组中的权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_update_channel_category_member_role (const NIMQChatUpdateChannelCategoryMemberRoleParam &param)
 更新指定成员在频道分组中的权限 More...
 
NIM_SDK_DLL_API void nim_qchat_role_get_channel_category_member_roles_page (const NIMQChatGetChannelCategoryMemberRolesPageParam &param)
 分页获取频道分组下的成员权限列表 More...
 

Detailed Description

圈组身份组相关接口定义

Author
NetEase Yunxin
Version
0.1
Date
2022-01-17

Function Documentation

◆ nim_qchat_role_add_channel_category_member_role()

void nim_qchat_role_add_channel_category_member_role ( const NIMQChatAddChannelCategoryMemberRoleParam param)

定制指定成员在频道分组中的权限

Parameters
param
Returns
无返回值

◆ nim_qchat_role_add_channel_category_role()

void nim_qchat_role_add_channel_category_role ( const NIMQChatAddChannelCategoryRoleParam param)

添加一个身份组到频道分组

Parameters
param
Returns
无返回值

◆ nim_qchat_role_channel_get_existing_roles()

void nim_qchat_role_channel_get_existing_roles ( const NIMQChatGetExistingRolesInChannelParam param)

获取指定频道下已存在的身份组列表

Parameters
param
Returns
无返回值

◆ nim_qchat_role_channel_get_list()

void nim_qchat_role_channel_get_list ( const NIMQChatGetChannelRolesParam param)

分页获取指定频道的身份组信息

Parameters
[in]param接口参数
See also
NIMQChatGetChannelRolesParam
Returns
无返回值

◆ nim_qchat_role_check_permission()

void nim_qchat_role_check_permission ( const NIMQChatCheckPermissionParam param)

查询当前登录用户是否拥有特定权限

Parameters
param
Returns
无返回值

◆ nim_qchat_role_check_permissions()

void nim_qchat_role_check_permissions ( const NIMQChatCheckPermissionsParam param)

批量查询当前登录用户是否拥有特定权限

Parameters
param
Returns
无返回值

◆ nim_qchat_role_get_channel_category_member_roles_page()

void nim_qchat_role_get_channel_category_member_roles_page ( const NIMQChatGetChannelCategoryMemberRolesPageParam param)

分页获取频道分组下的成员权限列表

Parameters
param
Returns
无返回值

◆ nim_qchat_role_get_channel_category_roles_page()

void nim_qchat_role_get_channel_category_roles_page ( const NIMQChatGetChannelCategoryRolesPageParam param)

分页获取频道分组下的身份组列表

Parameters
param
Returns
无返回值

◆ nim_qchat_role_member_add()

void nim_qchat_role_member_add ( const NIMQChatAddMemberRoleParam param)

定制指定成员在频道中的权限

Parameters
[in]param接口参数
See also
NIMQChatAddMemberRoleParam
Returns
无返回值

◆ nim_qchat_role_member_get_existing_roles()

void nim_qchat_role_member_get_existing_roles ( const NIMQChatGetExistingAccidsOfMemberRolesParam param)

批量获取指定频道下一批用户的定制权限信息,只会返回已存在的个人定制权限

Parameters
param
Returns
无返回值

◆ nim_qchat_role_member_get_list()

void nim_qchat_role_member_get_list ( const NIMQChatGetMemberRolesParam param)

分页查询指定频道下针对成员的定制权限列表

Parameters
[in]param接口参数
See also
NIMQChatGetMemberRolesParam
Returns
无返回值

◆ nim_qchat_role_member_get_roles_by_member_ids()

void nim_qchat_role_member_get_roles_by_member_ids ( const NIMQChatGetServerRolesByMemberIdsParam param)

通过一组 accid 列表查询该列表下所有人的所有已加入的身份组信息

Parameters
param接口参数
See also
Returns
无返回值

◆ nim_qchat_role_member_get_server_roles()

void nim_qchat_role_member_get_server_roles ( const NIMQChatGetServerRolesByMembersIdParam param)

通过用户账号查询自定义身份组列表

Parameters
[in]param接口参数
See also
NIMQChatGetServerRolesByMembersIdParam
Returns
无返回值

◆ nim_qchat_role_member_remove()

void nim_qchat_role_member_remove ( const NIMQChatRemoveMemberRoleParam param)

移除指定成员在频道中的定制权限

Parameters
[in]param接口参数
See also
NIMQChatRemoveMemberRoleParam
Returns
无返回值

◆ nim_qchat_role_member_update()

void nim_qchat_role_member_update ( const NIMQChatUpdateMemberRoleParam param)

更新指定成员在频道中的权限

Parameters
[in]param接口参数
See also
NIMQChatUpdateMemberRoleParam
Returns
无返回值

◆ nim_qchat_role_remove_channel_category_member_role()

void nim_qchat_role_remove_channel_category_member_role ( const NIMQChatRemoveChannelCategoryMemberRoleParam param)

取消指定成员在频道分组中的权限

Parameters
param
Returns
无返回值

◆ nim_qchat_role_remove_channel_category_role()

void nim_qchat_role_remove_channel_category_role ( const NIMQChatRemoveChannelCategoryRoleParam param)

从频道分组中移除一个身份组

Parameters
param
Returns
无返回值

◆ nim_qchat_role_server_batch_update_priorities()

void nim_qchat_role_server_batch_update_priorities ( const NIMQChatBatchUpdateServerRolePrioritiesParam param)

批量更新服务器身份组信息

Parameters
param
Returns
无返回值

◆ nim_qchat_role_server_get_existing_members()

void nim_qchat_role_server_get_existing_members ( const NIMQChatGetExistingAccidsInServerRoleParam param)

查询服务器某身份组是否包含指定成员

Parameters
param
Returns
无返回值

◆ nim_qchat_role_server_remove_members()

void nim_qchat_role_server_remove_members ( const NIMQChatRemoveMembersFromServerRoleParam param)

将部分成员从服务器指定身份组中移除

Parameters
param接口参数
See also
NIMQChatRemoveMembersFromServerRoleParam
Returns
无返回值

◆ nim_qchat_role_update_channel_category_member_role()

void nim_qchat_role_update_channel_category_member_role ( const NIMQChatUpdateChannelCategoryMemberRoleParam param)

更新指定成员在频道分组中的权限

Parameters
param
Returns
无返回值

◆ nim_qchat_role_update_channel_category_role()

void nim_qchat_role_update_channel_category_role ( const NIMQChatUpdateChannelCategoryRoleParam param)

更新频道分组中的身份组信息

Parameters
param
Returns
无返回值