nim_qchat_server_def.h

浏览该文件的文档.

 
#ifndef __NIM_QCHAT_SERVER_DEF_H__
#define __NIM_QCHAT_SERVER_DEF_H__
 
#include "nim_qchat_member_def.h"
#include "nim_qchat_public_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum NIMQChatServerInviteMode {
    kNIMQChatServerInviteModeNeedConfirm,
    kNIMQChatServerInviteModeNormal  // 不需要验证
};
 
enum NIMQChatServerApplyMode {
    kNIMQChatServerApplyModeNormal,
    kNIMQChatServerApplyModeNeedConfirm,
};
 
enum NIMQChatServerInviteFailReason {
    kNIMQChatServerInviteFailReasonExceedLimit = 1,
    kNIMQChatServerInviteFailReasonBanned = 2,
};
 
enum NIMQChatServerSearchType {
    kNIMQChatServerSearchTypeSquare = 1,
    kNIMQChatServerSearchTypePersonal = 2,
};
 
struct NIMQChatServerInfo {
    uint64_t server_id;
    uint32_t server_type;
    bool searchable;
    char* name;
    char* icon;
    char* custom;
    char* owner_id;
    uint64_t member_count;
    NIMQChatServerInviteMode invite_mode;
    NIMQChatServerApplyMode apply_mode;
    bool valid_flag;
    uint32_t channel_count;
    uint32_t channel_category_count;
    uint64_t create_time;
    uint64_t update_time;
    uint64_t reorder_weight;
};
 
enum NIMQChatInviteApplyRecordType {
    kNIMQChatInviteApplyRecordTypeApply = 1,
    kNIMQChatInviteApplyRecordTypeInvite = 2,
    kNIMQChatInviteApplyRecordTypeBeInvited = 3,
    kNIMQChatInviteApplyRecordTypeGenerateInviteCode = 4,
    kNIMQChatInviteApplyRecordTypeJoinByInviteCode = 5,
};
 
enum NIMQChatInviteApplyRecordStatus {
    kNIMQChatInviteApplyRecordStatusInitial = 0,
    kNIMQChatInviteApplyRecordStatusApprove = 1,
    kNIMQChatInviteApplyRecordStatusReject = 2,
    kNIMQChatInviteApplyRecordStatusApproveByOtherRequest = 3,
    kNIMQChatInviteApplyRecordStatusRejectByOtherRequest = 4,
    kNIMQChatInviteApplyRecordStatusAutoJoin = 5,
    kNIMQChatInviteApplyRecordStatusExpired = 6,
};
 
struct NIMQChatApplyInfoData {
    char* apply_postscript;
    char* update_accid;
    char* update_postscript;
};
 
struct NIMQChatInviteUserInfo {
    char* accid;
    char* update_postscript;
    NIMQChatInviteApplyRecordStatus status;
    uint64_t update_time;
};
 
struct NIMQChatInviteInfoData {
    char* invite_postscript;
    NIMQChatInviteUserInfo* invite_user_infos;
    size_t invite_user_infos_count;
};
 
struct NIMQChatBeInvitedInfoData {
    char* invite_postscript;
    char* update_postscript;
};
 
struct NIMQChatGenerateInviteCodeInfoData {
    char* invite_postscript;
    char* invite_code;
    uint32_t invite_count;
};
 
struct NIMQChatJoinByInviteCodeInfoData {
    char* invite_postscript;
    char* update_postscript;
    char* invite_code;
};
 
struct NIMQChatInviteApplyRecord {
    char* accid;
    NIMQChatInviteApplyRecordType type;
    uint64_t server_id;
    NIMQChatInviteApplyRecordStatus status;
    uint64_t request_id;
    uint64_t record_id;
    uint64_t create_time;
    uint64_t update_time;
    uint64_t expire_time;
    char* raw_data;
    union {
        NIMQChatApplyInfoData apply_data;
        NIMQChatInviteInfoData invite_data;
        NIMQChatBeInvitedInfoData be_invited_data;
        NIMQChatGenerateInviteCodeInfoData generate_invite_code_data;
        NIMQChatJoinByInviteCodeInfoData join_by_invite_code_data;
    };
};
 
struct NIMQChatServerCreateResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatServerInfo server_info;
};
 
typedef NIMQChatBaseResp NIMQChatServerDeleteResp;
 
typedef NIMQChatServerCreateResp NIMQChatServerUpdateResp;
 
struct NIMQChatServerGetServersResp {
    uint32_t res_code;
    void* user_data;
    size_t server_list_count;
    NIMQChatServerInfo* server_list;
};
 
struct NIMQChatServerGetServersPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    size_t server_list_count;
    NIMQChatServerInfo* server_list;
};
 
struct NIMQChatServerInviteResp {
    uint32_t res_code;
    void* user_data;
    uint64_t request_id;
    uint64_t expire_time;
    size_t accids_count;
    char** accids;
    NIMQChatServerInviteFailReason* fail_reasons;
};
 
typedef NIMQChatBaseResp NIMQChatServerAcceptInviteResp;
 
typedef NIMQChatBaseResp NIMQChatServerRejectInviteResp;
 
struct NIMQChatServerApplyResp {
    uint32_t res_code;
    void* user_data;
    uint64_t request_id;
    uint64_t expire_time;
};
 
typedef NIMQChatBaseResp NIMQChatServerAcceptApplyResp;
 
typedef NIMQChatBaseResp NIMQChatServerRejectApplyResp;
 
typedef NIMQChatBaseResp NIMQChatServerKickResp;
 
typedef NIMQChatBaseResp NIMQChatServerLeaveResp;
 
typedef NIMQChatBaseResp NIMQChatServerUpdateMemberInfoResp;
 
struct NIMQChatServerGetMembersResp {
    uint32_t res_code;
    void* user_data;
    size_t member_list_count;
    NIMQChatMemberInfo* member_list;
};
 
struct NIMQChatServerGetMembersPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    size_t member_list_count;
    NIMQChatMemberInfo* member_list;
};
 
struct NIMQChatServerSubscribeResp {
    uint32_t res_code;
    void* user_data;
    uint64_t* failed_servers;
    size_t failed_servers_count;
};
 
typedef NIMQChatBaseResp NIMQChatServerBanMemberResp;
 
typedef NIMQChatBaseResp NIMQChatServerUnbanMemberResp;
 
struct NIMQChatServerGetBannedMembersPageResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatPageInfo page_info;
    size_t ban_list_count;
    NIMQChatMemberBanInfo* ban_list;
};
 
typedef NIMQChatServerGetServersPageResp NIMQChatServerSearchPageResp;
 
typedef NIMQChatServerGetMembersResp NIMQChatServerMemberSearchResp;
 
struct NIMQChatServerUnreadResp {
    void* user_data;
    size_t unread_infos_count;
    NIMQChatServerUnreadInfo* unread_infos;
};
 
struct NIMQChatServerGenerateInviteCodeResp {
    uint32_t res_code;
    void* user_data;
    uint64_t server_id;
    uint64_t request_id;
    char* invite_code;
    uint64_t expire_time;
};
 
typedef NIMQChatBaseResp NIMQChatServerJoinByInviteCodeResp;
 
struct NIMQChatServerGetInviteApplyRecordOfServerResp {
    uint32_t res_code;
    void* user_data;
    size_t invite_apply_records_count;
    NIMQChatInviteApplyRecord* invite_apply_records;
};
 
typedef NIMQChatServerGetInviteApplyRecordOfServerResp NIMQChatServerGetInviteApplyRecordOfSelfResp;
 
struct NIMQChatServerMarkReadResp {
    uint32_t res_code;
    void* user_data;
    uint64_t* succeeded_servers;
    size_t succeeded_servers_count;
    uint64_t* failed_servers;
    size_t failed_servers_count;
    uint64_t timestamp;
};
 
struct NIMQChatServerSubscribeAllChannelResp {
    uint32_t res_code;
    void* user_data;
    uint64_t* failed_servers;
    size_t failed_servers_count;
    NIMQChatUnreadInfo* unread_infos;
    size_t unread_infos_count;
};
 
typedef NIMQChatServerSubscribeResp NIMQChatServerEnterAsVisitorResp;
 
typedef NIMQChatServerSubscribeResp NIMQChatServerLeaveAsVisitorResp;
 
typedef NIMQChatServerSubscribeResp NIMQChatServerSubscribeAsVisitorResp;
 
/* ----------------------------- 接口回调模板 ------------------------------- */
typedef void (*nim_qchat_server_unread_cb_func)(const NIMQChatServerUnreadResp* resp);
typedef void (*nim_qchat_server_create_cb_func)(const NIMQChatServerCreateResp* resp);
typedef void (*nim_qchat_server_remove_cb_func)(const NIMQChatServerDeleteResp* resp);
typedef void (*nim_qchat_server_update_cb_func)(const NIMQChatServerUpdateResp* resp);
typedef void (*nim_qchat_server_get_servers_cb_func)(const NIMQChatServerGetServersResp* resp);
typedef void (*nim_qchat_server_get_servers_page_cb_func)(const NIMQChatServerGetServersPageResp* resp);
typedef void (*nim_qchat_server_invite_cb_func)(const NIMQChatServerInviteResp* resp);
typedef void (*nim_qchat_server_accept_invite_cb_func)(const NIMQChatServerAcceptInviteResp* resp);
typedef void (*nim_qchat_server_reject_invite_cb_func)(const NIMQChatServerRejectInviteResp* resp);
typedef void (*nim_qchat_server_apply_cb_func)(const NIMQChatServerApplyResp* resp);
typedef void (*nim_qchat_server_accept_apply_cb_func)(const NIMQChatServerAcceptApplyResp* resp);
typedef void (*nim_qchat_server_reject_apply_cb_func)(const NIMQChatServerRejectApplyResp* resp);
typedef void (*nim_qchat_server_kick_cb_func)(const NIMQChatServerKickResp* resp);
typedef void (*nim_qchat_server_leave_cb_func)(const NIMQChatServerLeaveResp* resp);
typedef void (*nim_qchat_server_update_member_info_cb_func)(const NIMQChatServerUpdateMemberInfoResp* resp);
typedef void (*nim_qchat_server_get_members_cb_func)(const NIMQChatServerGetMembersResp* resp);
typedef void (*nim_qchat_server_get_members_page_cb_func)(const NIMQChatServerGetMembersPageResp* resp);
typedef void (*nim_qchat_server_subscribe_cb_func)(const NIMQChatServerSubscribeResp* resp);
typedef void (*nim_qchat_server_ban_member_cb_func)(const NIMQChatServerBanMemberResp* resp);
typedef void (*nim_qchat_server_unban_member_cb_func)(const NIMQChatServerUnbanMemberResp* resp);
typedef void (*nim_qchat_server_get_banned_members_page_cb_func)(const NIMQChatServerGetBannedMembersPageResp* resp);
typedef nim_qchat_server_get_servers_page_cb_func nim_qchat_server_search_page_cb_func;
typedef nim_qchat_server_get_members_cb_func nim_qchat_server_member_search_cb_func;
typedef void (*nim_qchat_server_generate_invite_code_cb_func)(const NIMQChatServerGenerateInviteCodeResp* resp);
typedef void (*nim_qchat_server_join_by_invite_code_cb_func)(const NIMQChatServerJoinByInviteCodeResp* resp);
typedef void (*nim_qchat_server_get_invite_apply_record_of_server_cb_func)(const NIMQChatServerGetInviteApplyRecordOfServerResp* resp);
typedef void (*nim_qchat_server_get_invite_apply_record_by_self_cb_func)(const NIMQChatServerGetInviteApplyRecordOfSelfResp* resp);
typedef void (*nim_qchat_server_mark_read_cb_func)(const NIMQChatServerMarkReadResp* resp);
typedef void (*nim_qchat_server_subscribe_all_channel_cb_func)(const NIMQChatServerSubscribeAllChannelResp* resp);
typedef void (*nim_qchat_server_enter_as_visitor_cb_func)(const NIMQChatServerEnterAsVisitorResp* resp);
typedef void (*nim_qchat_server_leave_as_visitor_cb_func)(const NIMQChatServerLeaveAsVisitorResp* resp);
typedef void (*nim_qchat_server_subscribe_as_visitor_cb_func)(const NIMQChatServerSubscribeAsVisitorResp* resp);
 
/* ----------------------------- 接口调用参数 ----------------------------- */
struct NIMQChatServerRegUnreadCbParam {
    nim_qchat_server_unread_cb_func cb;
    void* user_data;
};
 
struct NIMQChatServerCreateParam {
    nim_qchat_server_create_cb_func cb;
    void* user_data;
    NIMQChatServerInfo server_info;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatServerDeleteParam {
    nim_qchat_server_remove_cb_func cb;
    void* user_data;
    uint64_t server_id;
};
 
struct NIMQChatServerUpdateParam {
    nim_qchat_server_update_cb_func cb;
    void* user_data;
    NIMQChatServerInfo server_info;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatServerGetServersParam {
    nim_qchat_server_get_servers_cb_func cb;
    void* user_data;
    size_t server_ids_count;
    uint64_t* server_ids;
};
 
struct NIMQChatServerGetServersPageParam {
    nim_qchat_server_get_servers_page_cb_func cb;
    void* user_data;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatServerInviteParam {
    nim_qchat_server_invite_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char** invite_ids;
    size_t invite_ids_count;
    uint64_t ttl;
    char* postscript;
};
 
struct NIMQChatServerAcceptInviteParam {
    nim_qchat_server_accept_invite_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    uint64_t request_id;
};
 
struct NIMQChatServerRejectInviteParam {
    nim_qchat_server_reject_invite_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    char* postscript;
    uint64_t request_id;
};
 
struct NIMQChatServerApplyParam {
    nim_qchat_server_apply_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t ttl;
    char* postscript;
};
 
struct NIMQChatServerAcceptApplyParam {
    nim_qchat_server_accept_apply_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    uint64_t request_id;
};
 
struct NIMQChatServerRejectApplyParam {
    nim_qchat_server_reject_apply_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    char* postscript;
    uint64_t request_id;
};
 
struct NIMQChatServerKickParam {
    nim_qchat_server_kick_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char** accids;
    size_t accids_count;
};
 
struct NIMQChatServerLeaveParam {
    nim_qchat_server_leave_cb_func cb;
    void* user_data;
    uint64_t server_id;
};
 
struct NIMQChatServerUpdateMemberInfoParam {
    nim_qchat_server_update_member_info_cb_func cb;
    void* user_data;
    NIMQChatMemberInfo member_info;
    NIMQChatBusinessAntiSpamInfo anti_spam_info;
};
 
struct NIMQChatServerMemberPair {
    uint64_t server_id;
    char* accid;
};
 
struct NIMQChatServerGetMembersParam {
    nim_qchat_server_get_members_cb_func cb;
    void* user_data;
    NIMQChatServerMemberPair* server_accid_list;
    size_t server_accid_list_count;
};
 
struct NIMQChatServerGetMembersPageParam {
    nim_qchat_server_get_members_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatServerSubscribeParam {
    nim_qchat_server_subscribe_cb_func cb;
    void* user_data;
    NIMQChatSubscribeOpeType ope_type;
    NIMQChatSubscribeType sub_type;
    size_t server_ids_count;
    uint64_t* server_ids;
};
 
struct NIMQChatServerBanMemberParam {
    nim_qchat_server_ban_member_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    char* custom;
};
 
struct NIMQChatServerUnbanMemberParam {
    nim_qchat_server_unban_member_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* accid;
    char* custom;
};
 
struct NIMQChatServerGetBannedMembersPageParam {
    nim_qchat_server_get_banned_members_page_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t timestamp;
    uint32_t limit;
};
 
struct NIMQChatServerSearchPageParam {
    nim_qchat_server_search_page_cb_func cb;
    void* user_data;
    char* keyword;
    uint64_t start_time;
    uint64_t end_time;
    NIMQChatSearchOrder order;
    NIMQChatServerSearchSort sort;
    uint32_t* server_types;
    size_t server_types_count;
    NIMQChatServerSearchType search_type;
    uint32_t limit;
    char* cursor;
};
 
struct NIMQChatServerMemberSearchParam {
    nim_qchat_server_member_search_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* keyword;
    uint32_t limit;
};
 
struct NIMQChatServerGenerateInviteCodeParam {
    nim_qchat_server_generate_invite_code_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t ttl;
};
 
struct NIMQChatServerJoinByInviteCodeParam {
    nim_qchat_server_join_by_invite_code_cb_func cb;
    void* user_data;
    uint64_t server_id;
    char* invite_code;
    char* postscript;
};
 
struct NIMQChatServerGetInviteApplyRecordOfServerParam {
    nim_qchat_server_get_invite_apply_record_of_server_cb_func cb;
    void* user_data;
    uint64_t server_id;
    uint64_t start_time;
    uint64_t end_time;
    bool reverse;
    uint32_t limit;
    uint64_t exclude_record_id;
};
 
struct NIMQChatServerGetInviteApplyRecordOfSelfParam {
    nim_qchat_server_get_invite_apply_record_by_self_cb_func cb;
    void* user_data;
    uint64_t start_time;
    uint64_t end_time;
    bool reverse;
    uint32_t limit;
    uint64_t exclude_record_id;
};
 
struct NIMQChatServerMarkReadParam {
    nim_qchat_server_mark_read_cb_func cb;
    void* user_data;
    uint64_t* server_ids;
    size_t server_ids_count;
};
 
struct NIMQChatServerSubscribeAllChannelParam {
    nim_qchat_server_subscribe_all_channel_cb_func cb;
    void* user_data;
    NIMQChatSubscribeType sub_type;
    uint64_t* server_ids;
    size_t server_ids_count;
};
 
struct NIMQChatServerEnterAsVisitorParam {
    nim_qchat_server_enter_as_visitor_cb_func cb;
    void* user_data;
    size_t server_ids_count;
    uint64_t* server_ids;
};
 
struct NIMQChatServerLeaveAsVisitorParam {
    nim_qchat_server_leave_as_visitor_cb_func cb;
    void* user_data;
    size_t server_ids_count;
    uint64_t* server_ids;
};
 
struct NIMQChatServerSubscribeAsVisitorParam {
    nim_qchat_server_subscribe_as_visitor_cb_func cb;
    void* user_data;
    NIMQChatSubscribeOpeType ope_type;
    size_t server_ids_count;
    uint64_t* server_ids;
 
    // 以下字段为内部使用
    NIMQChatSubscribeType sub_type;
};
 
#ifdef __cplusplus
}
#endif
 
#endif  // __NIM_QCHAT_SERVER_DEF_H__