nim_qchat_channel_def.h

浏览该文件的文档.

 
#ifndef __NIM_QCHAT_CHANNEL_DEF_H__
#define __NIM_QCHAT_CHANNEL_DEF_H__
 
#include "nim_qchat_member_def.h"
#include "nim_qchat_public_def.h"
#include "nim_qchat_role_def.h"
#include "nim_qchat_server_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum NIMQChatChannelType {
    kNIMQChatChannelTypeText,
    kNIMQChatChannelTypeRTC,
    kNIMQChatChannelTypeCustom = 100
};
 
enum NIMQChatChannelMemberIdentifyType {
    kNIMQChatWhite = 1,
    kNIMQChatBlack = 2,
};
 
enum NIMQChatChannelMemberIdentifyOpeType {
    kNIMQChatChannelMemberIdentifyOpeTypeAdd = 1,
    kNIMQChatChannelMemberIdentifyOpeTypeRemove = 2,
};
 
enum NIMQChatChannelWhiteBlackType {
    kNIMQChatChannelWhite = 1,
    kNIMQChatChannelBlack = 2,
};
 
enum NIMQChatChannelWhiteBlackOpeType {
    kNIMQChatChannelWhiteBlackOpeTypeAdd = 1,
    kNIMQChatChannelWhiteBlackOpeTypeRemove = 2,
};
 
struct NIMQChatChannelInfo {
    uint64_t server_id;
    uint64_t channel_id;
    char* name;
    char* topic;
    char* custom;
    NIMQChatChannelType type;
    char* owner;
    NIMQChatChannelViewMode view_mode;
    NIMQChatChannelVisitorMode visitor_mode;
    bool valid_flag;
    uint64_t create_time;
    uint64_t update_time;
    uint64_t category_id;
    NIMQChatChannelSyncMode sync_mode;
    uint64_t reorder_weight;
};
 
struct NIMQChatChannelRTCAudioInfo {
    char* profile;
    char* scenario;
};
 
struct NIMQChatChannelRTCVideoInfo {
    uint32_t width;
    uint32_t height;
    uint32_t fps;
};
 
struct NIMQChatChannelRTCInfo {
    uint32_t limit;
    NIMQChatChannelRTCAudioInfo audio;
    NIMQChatChannelRTCVideoInfo video;
};
 
struct NIMQChatChannelCategoryInfo {
    uint64_t server_id;
    uint64_t category_id;
    char* name;
    char* custom;
    char* owner;
    NIMQChatChannelViewMode view_mode;
    bool valid_flag;
    uint64_t create_time;
    uint64_t update_time;
    uint32_t channel_number;
};
 
struct NIMQChatChannelCreateResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelInfo channel_info;
};
 
typedef NIMQChatChannelCreateResp NIMQChatChannelUpdateResp;
 
typedef NIMQChatChannelCreateResp NIMQChatChannelUpdateCategoryInfoResp;
 
typedef NIMQChatBaseResp NIMQChatChannelDeleteResp;
 
struct NIMQChatChannelGetChannelsResp {
    uint32_t res_code;
    void* user_data;
    size_t channel_list_count;
    NIMQChatChannelInfo* channel_list;
};
 
struct NIMQChatChannelGetChannelsPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    size_t channel_list_count;
    NIMQChatChannelInfo* channel_list;
};
 
typedef NIMQChatServerGetMembersPageResp NIMQChatChannelGetMembersPageResp;
 
struct NIMQChatChannelQueryUnreadInfoResp {
    NIMQChatUnreadInfo* unread_infos;
    size_t unread_info_count;
    uint32_t res_code;
    void* user_data;
};
 
struct NIMQChatChannelSubscribeResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelIDInfo* failed_channels;
    size_t failed_channels_count;
    NIMQChatUnreadInfo* unread_infos;
    size_t unread_infos_count;
};
 
struct NIMQChatChannelUnreadResp {
    void* user_data;
    size_t unread_infos_count;
    NIMQChatUnreadInfo* unread_infos;
};
 
typedef NIMQChatBaseResp NIMQChatChannelUpdateWhiteBlackRoleResp;
 
typedef NIMQChatBaseResp NIMQChatChannelUpdateWhiteBlackMembersResp;
 
struct NIMQChatChannelGetWhiteBlackRolesPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    NIMQChatRoleInfo* roles;
    size_t role_count;
};
 
struct NIMQChatChannelGetWhiteBlackMembersPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    NIMQChatMemberInfo* members;
    size_t member_count;
};
 
struct NIMQChatChannelGetExistingWhiteBlackRolesResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo* roles;
    size_t role_count;
};
 
struct NIMQChatChannelGetExistingWhiteBlackMembersResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMemberInfo* members;
    size_t member_count;
};
 
typedef NIMQChatChannelGetChannelsPageResp NIMQChatChannelSearchPageResp;
 
struct NIMQChatChannelMemberSearchResp {
    uint32_t res_code;
    void* user_data;
    size_t member_list_count;
    NIMQChatMemberInfo* member_list;
};
 
struct NIMQChatChannelCategoryCreateResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelCategoryInfo category_info;
};
 
typedef NIMQChatBaseResp NIMQChatChannelCategoryRemoveResp;
 
typedef NIMQChatChannelCategoryCreateResp NIMQChatChannelCategoryUpdateResp;
 
struct NIMQChatChannelGetCategoriesByIDResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelCategoryInfo* categories;
    size_t category_count;
};
 
struct NIMQChatChannelGetCategoriesPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    NIMQChatChannelCategoryInfo* categories;
    size_t category_count;
};
 
typedef NIMQChatChannelGetChannelsPageResp NIMQChatChannelGetCategoryChannelsPageResp;
 
typedef NIMQChatBaseResp NIMQChatChannelCategoryUpdateWhiteBlackRoleResp;
 
struct NIMQChatChannelCategoryGetWhiteBlackRolesPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    NIMQChatRoleInfo* roles;
    size_t role_count;
};
 
struct NIMQChatChannelCategoryGetExistingWhiteBlackRolesResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatRoleInfo* roles;
    size_t role_count;
};
 
typedef NIMQChatBaseResp NIMQChatChannelCategoryUpdateWhiteBlackMembersResp;
 
struct NIMQChatChannelCategoryGetWhiteBlackMembersPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    NIMQChatMemberInfo* members;
    size_t member_count;
};
 
struct NIMQChatChannelCategoryGetWhiteBlackMembersResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMemberInfo* members;
    size_t member_count;
};
 
typedef NIMQChatBaseResp NIMQChatChannelUpdateRTCInfoResp;
 
struct NIMQChatChannelGetRTCInfoResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelRTCInfo rtc_info;
};
 
struct NIMQChatChannelGetRTCOnlineMembersResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatMemberInfo* members;
    size_t member_count;
};
 
struct NIMQChatChannelSubscribeAsVisitorResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatChannelIDInfo* failed_channels;
    size_t failed_channels_count;
};
 
/* ------------------------------- 接口回调模板 -------------------------------- */
typedef void (*nim_qchat_channel_unread_cb_func)(const NIMQChatChannelUnreadResp* resp);
typedef void (*nim_qchat_channel_create_cb_func)(const NIMQChatChannelCreateResp* resp);
typedef void (*nim_qchat_channel_remove_cb_func)(const NIMQChatChannelDeleteResp* resp);
typedef void (*nim_qchat_channel_update_cb_func)(const NIMQChatChannelUpdateResp* resp);
typedef void (*nim_qchat_channel_update_category_info_cb_func)(const NIMQChatChannelUpdateCategoryInfoResp* resp);
typedef void (*nim_qchat_channel_get_channels_cb_func)(const NIMQChatChannelGetChannelsResp* resp);
typedef void (*nim_qchat_channel_get_channels_page_cb_func)(const NIMQChatChannelGetChannelsPageResp* resp);
typedef void (*nim_qchat_channel_get_members_page_cb_func)(const NIMQChatChannelGetMembersPageResp* resp);
typedef void (*nim_qchat_channel_query_unread_info_cb_func)(const NIMQChatChannelQueryUnreadInfoResp* resp);
typedef void (*nim_qchat_channel_subscribe_cb_func)(const NIMQChatChannelSubscribeResp* resp);
typedef void (*nim_qchat_channel_update_white_black_role_cb_func)(const NIMQChatChannelUpdateWhiteBlackRoleResp* resp);
typedef void (*nim_qchat_channel_update_white_black_members_cb_func)(const NIMQChatChannelUpdateWhiteBlackMembersResp* resp);
typedef void (*nim_qchat_channel_get_white_black_roles_page_cb_func)(const NIMQChatChannelGetWhiteBlackRolesPageResp* resp);
typedef void (*nim_qchat_channel_get_white_black_members_page_cb_func)(const NIMQChatChannelGetWhiteBlackMembersPageResp* resp);
typedef void (*nim_qchat_channel_get_existing_white_black_roles_cb_func)(const NIMQChatChannelGetExistingWhiteBlackRolesResp* resp);
typedef void (*nim_qchat_channel_get_existing_white_black_members_cb_func)(const NIMQChatChannelGetExistingWhiteBlackMembersResp* resp);
typedef nim_qchat_channel_get_channels_page_cb_func nim_qchat_channel_search_page_cb_func;
typedef void (*nim_qchat_channel_member_search_cb_func)(const NIMQChatChannelMemberSearchResp* resp);
typedef void (*nim_qchat_channel_create_category_cb_func)(const NIMQChatChannelCategoryCreateResp* resp);
typedef void (*nim_qchat_channel_remove_category_cb_func)(const NIMQChatChannelCategoryRemoveResp* resp);
typedef void (*nim_qchat_channel_update_category_cb_func)(const NIMQChatChannelCategoryUpdateResp* resp);
typedef void (*nim_qchat_channel_get_categories_cb_func)(const NIMQChatChannelGetCategoriesByIDResp* resp);
typedef void (*nim_qchat_channel_get_categories_page_cb_func)(const NIMQChatChannelGetCategoriesPageResp* resp);
typedef void (*nim_qchat_channel_get_category_channels_page_cb_func)(const NIMQChatChannelGetCategoryChannelsPageResp* resp);
typedef void (*nim_qchat_channel_update_category_white_black_role_cb_func)(const NIMQChatChannelCategoryUpdateWhiteBlackRoleResp* resp);
typedef void (*nim_qchat_channel_get_category_white_black_roles_page_cb_func)(const NIMQChatChannelCategoryGetWhiteBlackRolesPageResp* resp);
typedef void (*nim_qchat_channel_update_category_white_black_members_cb_func)(const NIMQChatChannelCategoryUpdateWhiteBlackMembersResp* resp);
typedef void (*nim_qchat_channel_get_category_white_black_members_page_cb_func)(const NIMQChatChannelCategoryGetWhiteBlackMembersPageResp* resp);
typedef void (*nim_qchat_channel_get_category_white_black_roles_cb_func)(const NIMQChatChannelCategoryGetExistingWhiteBlackRolesResp* resp);
typedef void (*nim_qchat_channel_get_category_white_black_members_cb_func)(const NIMQChatChannelCategoryGetWhiteBlackMembersResp* resp);
typedef void (*nim_qchat_channel_update_rtc_info_cb_func)(const NIMQChatChannelUpdateRTCInfoResp* resp);
typedef void (*nim_qchat_channel_get_rtc_info_cb_func)(const NIMQChatChannelGetRTCInfoResp* resp);
typedef void (*nim_qchat_channel_get_rtc_online_members_cb_func)(const NIMQChatChannelGetRTCOnlineMembersResp* resp);
typedef void (*nim_qchat_channel_subscribe_as_visitor_cb_func)(const NIMQChatChannelSubscribeAsVisitorResp* resp);
 
/* ------------------------------- 接口调用参数 ------------------------------ */
struct NIMQChatChannelRegUnreadCbParam {
    nim_qchat_channel_unread_cb_func cb;
    void* user_data;
};
 
struct NIMQChatChannelCreateParam {
    nim_qchat_channel_create_cb_func cb;
    void* user_data;
    NIMQChatChannelInfo channel_info;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatChannelDeleteParam {
    nim_qchat_channel_remove_cb_func cb;
    void* user_data;
    uint64_t channel_id;
};
 
struct NIMQChatChannelUpdateParam {
    nim_qchat_channel_update_cb_func cb;
    void* user_data;
    uint64_t channel_id;
    char* name;
    char* topic;
    char* custom;
    NIMQChatChannelViewMode view_mode;
    NIMQChatChannelVisitorMode visitor_mode;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatChannelUpdateCategoryInfoParam {
    nim_qchat_channel_update_category_info_cb_func cb;
    void* user_data;
    uint64_t channel_id;
    uint64_t category_id;
    NIMQChatChannelSyncMode sync_mode;
};
 
struct NIMQChatChannelGetChannelsParam {
    nim_qchat_channel_get_channels_cb_func cb;
    void* user_data;
    size_t channel_ids_count;
    uint64_t* channel_ids;
};
 
struct NIMQChatChannelGetChannelsPageParam {
    nim_qchat_channel_get_channels_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelGetMembersPageParam {
    nim_qchat_channel_get_members_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelQueryUnreadInfoParam {
    nim_qchat_channel_query_unread_info_cb_func cb;
    void* user_data;
    size_t id_infos_count;
    NIMQChatChannelIDInfo* id_infos;
};
 
struct NIMQChatChannelSubscribeParam {
    nim_qchat_channel_subscribe_cb_func cb;
    void* user_data;
    NIMQChatSubscribeOpeType ope_type;
    NIMQChatSubscribeType sub_type;
    size_t id_infos_count;
    NIMQChatChannelIDInfo* id_infos;
};
 
struct NIMQChatChannelUpdateWhiteBlackRoleParam {
    nim_qchat_channel_update_white_black_role_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t role_id;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatChannelUpdateWhiteBlackMembersParam {
    nim_qchat_channel_update_white_black_members_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    char** accids;
    size_t accids_count;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatChannelGetWhiteBlackRolesPageParam {
    nim_qchat_channel_get_white_black_roles_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatChannelWhiteBlackType type;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelGetWhiteBlackMembersPageParam {
    nim_qchat_channel_get_white_black_members_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatChannelWhiteBlackType type;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelGetExistingWhiteBlackRolesParam {
    nim_qchat_channel_get_existing_white_black_roles_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatChannelWhiteBlackType type;
    uint64_t* role_ids;
    size_t role_ids_count;
};
 
struct NIMQChatChannelGetExistingWhiteBlackMembersParam {
    nim_qchat_channel_get_existing_white_black_members_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatChannelWhiteBlackType type;
    char** accids;
    size_t accids_count;
};
 
struct NIMQChatChannelSearchPageParam {
    nim_qchat_channel_search_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* keyword;
    uint64_t start_time;
    uint64_t end_time;
    NIMQChatSearchOrder order;
    NIMQChatChannelSearchSort sort;
    uint32_t limit;
    char* cursor;
};
 
struct NIMQChatChannelMemberSearchParam {
    nim_qchat_channel_member_search_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    char* keyword;
    uint32_t limit;
};
 
struct NIMQChatChannelCategoryCreateParam {
    nim_qchat_channel_create_category_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* name;
    char* custom;
    NIMQChatChannelViewMode view_mode;
};
 
struct NIMQChatChannelCategoryRemoveParam {
    nim_qchat_channel_remove_category_cb_func cb;
    void* user_data;
    uint64_t category_id;
};
 
struct NIMQChatChannelCategoryUpdateParam {
    nim_qchat_channel_update_category_cb_func cb;
    void* user_data;
    uint64_t category_id;
    char* name;
    char* custom;
    NIMQChatChannelViewMode view_mode;
};
 
struct NIMQChatChannelGetCategoriesByIDParam {
    nim_qchat_channel_get_categories_cb_func cb;
    void* user_data;
    uint64_t* category_ids;
    size_t category_ids_count;
};
 
struct NIMQChatChannelGetCategoriesPageParam {
    nim_qchat_channel_get_categories_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelGetCategoryChannelsPageParam {
    nim_qchat_channel_get_category_channels_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelCategoryUpdateWhiteBlackRoleParam {
    nim_qchat_channel_update_category_white_black_role_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    uint64_t role_id;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatChannelCategoryGetWhiteBlackRolesPageParam {
    nim_qchat_channel_get_category_white_black_roles_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    NIMQChatChannelWhiteBlackType type;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelCategoryGetExistingWhiteBlackRolesParam {
    nim_qchat_channel_get_category_white_black_roles_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    NIMQChatChannelWhiteBlackType type;
    uint64_t* role_ids;
    size_t role_ids_count;
};
 
struct NIMQChatChannelCategoryUpdateWhiteBlackMembersParam {
    nim_qchat_channel_update_category_white_black_members_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    char** accids;
    size_t accids_count;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatChannelCategoryGetWhiteBlackMembersPageParam {
    nim_qchat_channel_get_category_white_black_members_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    NIMQChatChannelWhiteBlackType type;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatChannelCategoryGetExistingWhiteBlackMembersParam {
    nim_qchat_channel_get_category_white_black_members_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t category_id;
    NIMQChatChannelWhiteBlackType type;
    char** accids;
    size_t accids_count;
};
 
struct NIMQChatChannelUpdateRTCInfoParam {
    nim_qchat_channel_update_rtc_info_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatChannelRTCInfo rtc_info;
};
 
struct NIMQChatChannelGetRTCInfoParam {
    nim_qchat_channel_get_rtc_info_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
};
 
struct NIMQChatChannelGetRTCOnlineMembersParam {
    nim_qchat_channel_get_rtc_online_members_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t channel_id;
};
 
struct NIMQChatChannelSubscribeAsVisitorParam {
    nim_qchat_channel_subscribe_as_visitor_cb_func cb;
    void* user_data;
    NIMQChatSubscribeOpeType ope_type;
    size_t id_infos_count;
    NIMQChatChannelIDInfo* id_infos;
 
    // 以下字段为内部使用
    NIMQChatSubscribeType sub_type;
};
 
#ifdef __cplusplus
}
#endif
 
#endif  // __NIM_QCHAT_CHANNEL_DEF_H__