nim_qchat_role_def.h

浏览该文件的文档.

 
#ifndef __NIM_QCHAT_ROLE_DEF_H__
#define __NIM_QCHAT_ROLE_DEF_H__
 
#include "nim_qchat_member_def.h"
#include "nim_qchat_public_def.h"
 
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,
    kPermissionMentionRole,
};
 
enum NIMQChatPermissionsOption {
    kPermissionSwitchDeny = -1,
    kPermissionSwitchExtend,
    kPermissionSwitchAllow
};
 
struct NIMQChatPermissionGroup {
    uint32_t permission;
    NIMQChatPermissionsOption option;
};
 
enum NIMQChatRoleType {
    kRoleTypeUnkonwn = 0,
    kRoleTypeEveryone,
    kRoleTypeCustom
};
 
struct NIMQChatRoleMemberInfo {
    NIMQChatMemberInfo member_info;
    uint64_t role_id;
};
 
struct NIMQChatServerRoleInfo {
    uint32_t member_count;
    uint64_t priority;
};
 
struct NIMQChatChannelRoleInfo {
    uint64_t channel_id;
    uint64_t parent_role_id;
};
 
struct NIMQChatChannelCategoryRoleInfo {
    uint64_t category_id;
    uint64_t parent_role_id;
    bool valid_flag;
};
 
struct NIMQChatRoleInfo {
    uint64_t server_id;
    uint64_t role_id;
    char* role_name;
    char* role_icon;
    char* extension;
    NIMQChatPermissionGroup* permissions;
    size_t permissions_count;
    NIMQChatRoleType role_type;
    uint64_t create_time;
    uint64_t update_time;
    union {
        NIMQChatServerRoleInfo server_role;
        NIMQChatChannelRoleInfo channel_role;
        NIMQChatChannelCategoryRoleInfo channel_category_role;
    };
};
 
struct NIMQChatMemberRoleInfo {
    uint64_t channel_id;
    uint64_t role_id;
    NIMQChatMemberInfo member_info;
    NIMQChatPermissionGroup* permissions;
    size_t permissions_count;
    uint64_t create_time;
    uint64_t update_time;
};
 
struct NIMQChatChannelCategoryMemberRoleInfo {
    uint64_t category_id;
    uint64_t role_id;
    NIMQChatMemberInfo member_info;
    NIMQChatPermissionGroup* permissions;
    size_t permissions_count;
    uint64_t create_time;
    uint64_t update_time;
};
 
struct NIMQChatCreateServerRoleResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo role_info;
};
 
struct NIMQChatUpdateServerRoleResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo role_info;
};
 
typedef NIMQChatBaseResp NIMQChatDeleteServerRoleResp;
 
struct NIMQChatGetServerRolesResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo* roles;
    size_t role_count;
    NIMQChatRoleInfo* joined_roles;
    size_t joined_role_count;
};
 
typedef char* QChatMemberAccountId;
 
struct NIMQChatAddMembersToServerRoleResp {
    uint32_t res_code;
    void* user_data;
    QChatMemberAccountId* succeed_list;
    size_t succeed_count;
    QChatMemberAccountId* failed_list;
    size_t failed_count;
};
 
typedef NIMQChatAddMembersToServerRoleResp NIMQChatRemoveMembersFromServerRoleResp;
 
struct NIMQChatGetMembersFromServerRoleResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleMemberInfo* members;
    size_t member_count;
};
 
struct NIMQChatAddChannelRoleResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo role_info;
};
 
typedef NIMQChatAddChannelRoleResp NIMQChatUpdateChannelRoleResp;
 
typedef NIMQChatAddChannelRoleResp NIMQChatAddChannelCategoryRoleResp;
 
typedef NIMQChatAddChannelRoleResp NIMQChatUpdateChannelCategoryRoleResp;
 
typedef NIMQChatBaseResp NIMQChatRemoveChannelRoleResp;
 
typedef NIMQChatBaseResp NIMQChatRemoveChannelCategoryRoleResp;
 
struct NIMQChatGetChannelRolesResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo* role_infos;
    size_t role_count;
};
 
typedef NIMQChatGetChannelRolesResp NIMQChatGetChannelCategoryRolesPageResp;
 
struct NIMQChatAddMemberRoleResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMemberRoleInfo role_info;
};
 
struct NIMQChatAddChannelCategoryMemberRoleResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelCategoryMemberRoleInfo role_info;
};
 
typedef NIMQChatAddMemberRoleResp NIMQChatUpdateMemberRoleResp;
 
typedef NIMQChatAddChannelCategoryMemberRoleResp NIMQChatUpdateChannelCategoryMemberRoleResp;
 
typedef NIMQChatBaseResp NIMQChatRemoveMemberRoleResp;
 
typedef NIMQChatBaseResp NIMQChatRemoveChannelCategoryMemberRoleResp;
 
struct NIMQChatGetMemberRolesResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMemberRoleInfo* role_infos;
    size_t member_role_count;
};
 
struct NIMQChatGetChannelCategoryMemberRolesPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelCategoryMemberRoleInfo* role_infos;
    size_t member_role_count;
};
 
typedef NIMQChatGetServerRolesResp NIMQChatGetServerRolesByMembersIdResp;
 
struct NIMQChatRoleInfoOfMember {
    char* member_id;
    NIMQChatRoleInfo* roles;
    size_t role_count;
};
 
struct NIMQChatGetServerRolesByMemberIdsResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfoOfMember* roles_of_member;
    size_t count;
};
 
typedef NIMQChatGetChannelRolesResp NIMQChatGetExistingRolesInChannelResp;
 
typedef NIMQChatGetServerRolesResp NIMQChatUpdateServerRolePrioritiesResp;
 
struct NIMQChatGetExistingAccidsOfMemberRolesResp {
    uint32_t res_code;
    void* user_data;
    QChatMemberAccountId* member_ids;
    size_t member_ids_count;
};
 
struct NIMQChatCheckPermissionResp {
    uint32_t res_code;
    void* user_data;
    bool has_permission;
};
 
struct NIMQChatCheckPermissionsResp {
    uint32_t res_code;
    void* user_data;
    size_t permissions_count;
    uint32_t* permissions;
    NIMQChatPermissionsOption* options;
};
 
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);
typedef void (*nim_qchat_role_member_get_roles_by_ids_cb_func)(const NIMQChatGetServerRolesByMemberIdsResp* resp);
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);
typedef void (*nim_qchat_role_get_accids_in_server_role_cb_func)(const NIMQChatGetExistingAccidsInServerRoleResp* resp);
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);
 
struct NIMQChatCreateServerRoleParam {
    nim_qchat_role_server_create_cb_func cb;
    void* user_data;
    NIMQChatRoleInfo role_info;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatUpdateServerRoleParam {
    nim_qchat_role_server_update_cb_func cb;
    void* user_data;
    NIMQChatRoleInfo role_info;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatBatchUpdateServeRolePriorityGroup {
    uint64_t role_id;
    uint64_t priority;
};
 
struct NIMQChatBatchUpdateServerRolePrioritiesParam {
    nim_qchat_role_server_batch_update_priorities_cb_func cb;
    void* user_data;
    uint64_t server_id;
    NIMQChatBatchUpdateServeRolePriorityGroup* update_priority_info;
    size_t update_count;
};
 
struct NIMQChatDeleteServerRoleParam {
    nim_qchat_role_server_delete_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t role_id;
};
 
struct NIMQChatGetServerRolesParam {
    nim_qchat_role_server_get_list_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint32_t limit;
    uint64_t priority;
    uint64_t channel_id;
    uint64_t channel_category_id;
};
 
struct NIMQChatAddMembersToServerRoleParam {
    nim_qchat_role_server_add_member_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t role_id;
    char** members;
    size_t member_count;
};
 
typedef NIMQChatAddMembersToServerRoleParam NIMQChatRemoveMembersFromServerRoleParam;
 
struct NIMQChatGetMembersFromServerRoleParam {
    nim_qchat_role_server_get_members_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t role_id;
    uint64_t timestamp;
    uint32_t limit;
    char* begin_accid;
};
 
struct NIMQChatAddChannelRoleParam {
    nim_qchat_role_channel_add_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t parent_role_id;
    uint64_t channel_id;
};
 
struct NIMQChatUpdateChannelRoleParam {
    nim_qchat_role_channel_update_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t role_id;
    uint64_t channel_id;
    NIMQChatPermissionGroup* permissions;
    size_t permission_count;
};
 
struct NIMQChatRemoveChannelRoleParam {
    nim_qchat_role_channel_remove_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t role_id;
};
 
struct NIMQChatGetChannelRolesParam {
    nim_qchat_role_channel_get_list_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatAddMemberRoleParam {
    nim_qchat_role_member_add_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    char* accid;
};
 
struct NIMQChatUpdateMemberRoleParam {
    nim_qchat_role_member_update_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    char* accid;
    NIMQChatPermissionGroup* permissions;
    size_t permission_count;
};
 
struct NIMQChatRemoveMemberRoleParam {
    nim_qchat_role_member_remove_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    char* accid;
};
 
struct NIMQChatGetMemberRolesParam {
    nim_qchat_role_member_get_list_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatGetServerRolesByMembersIdParam {
    nim_qchat_role_member_roles_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    uint64_t timestamp;
    uint32_t limit;
};
 
enum NIMQChatSortType {
    kNIMQChatSortByCreateTime = 1,
    kNIMQChatSortByPriority,
};
 
struct NIMQChatGetServerRolesByMemberIdsParam {
    nim_qchat_role_member_get_roles_by_ids_cb_func cb;
    void* user_data;
    uint64_t server_id;
    QChatMemberAccountId* accids;
    size_t account_count;
    NIMQChatSortType sort_type;
    NIMQChatSearchOrder search_order;
};
 
struct NIMQChatGetExistingRolesInChannelParam {
    nim_qchat_role_get_existing_roles_in_channel_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t* role_ids;
    size_t role_count;
};
 
struct NIMQChatGetExistingAccidsOfMemberRolesParam {
    nim_qhcat_role_get_existing_accids_of_member_roles_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    QChatMemberAccountId* accids;
    size_t account_count;
};
 
struct NIMQChatGetExistingAccidsInServerRoleParam {
    nim_qchat_role_get_accids_in_server_role_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t role_id;
    char** accids;
    size_t account_count;
};
 
struct NIMQChatCheckPermissionParam {
    nim_qchat_role_check_permission_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint32_t permission;
};
 
struct NIMQChatCheckPermissionsParam {
    nim_qchat_role_check_permissions_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    size_t permission_count;
    uint32_t* permissions;
};
 
struct NIMQChatAddChannelCategoryRoleParam {
    nim_qchat_role_channel_category_add_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t parent_role_id;
};
 
struct NIMQChatUpdateChannelCategoryRoleParam {
    nim_qchat_role_channel_category_update_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t role_id;
    NIMQChatPermissionGroup* permissions;
    size_t permission_count;
};
 
struct NIMQChatRemoveChannelCategoryRoleParam {
    nim_qchat_role_channel_category_remove_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t role_id;
};
 
struct NIMQChatGetChannelCategoryRolesPageParam {
    nim_qchat_role_channel_category_get_list_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatAddChannelCategoryMemberRoleParam {
    nim_qchat_role_channel_category_member_role_add_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    char* accid;
};
 
struct NIMQChatUpdateChannelCategoryMemberRoleParam {
    nim_qchat_role_channel_category_member_role_update_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    char* accid;
    NIMQChatPermissionGroup* permissions;
    size_t permission_count;
};
 
struct NIMQChatRemoveChannelCategoryMemberRoleParam {
    nim_qchat_role_channel_category_member_role_remove_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    char* accid;
};
 
struct NIMQChatGetChannelCategoryMemberRolesPageParam {
    nim_qchat_role_channel_category_member_role_get_list_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
#endif  // __NIM_QCHAT_ROLE_DEF_H__