nim_qchat_system_notification_def.h

浏览该文件的文档.

 
#ifndef __NIM_QCHAT_SYSTEM_NOTIFICATION_DEF_H__
#define __NIM_QCHAT_SYSTEM_NOTIFICATION_DEF_H__
 
#include "nim_qchat_channel_def.h"
#include "nim_qchat_message_def.h"
#include "nim_qchat_public_def.h"
#include "nim_qchat_server_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum NIMQChatSystemNotificationToType {
    kNIMQChatSystemNotificationToTypeUnknown,        
    kNIMQChatSystemNotificationToTypeServer,         
    kNIMQChatSystemNotificationToTypeChannel,        
    kNIMQChatSystemNotificationToTypeServerAccids,   
    kNIMQChatSystemNotificationToTypeChannelAccids,  
    kNIMQChatSystemNotificationToTypeAccids,         
};
 
enum NIMQChatSystemNotificationType {
    kNIMQChatSystemNotificationTypeUnkonwn = 0,
    kNIMQChatSystemNotificationTypeMemberInvite = 1,
    kNIMQChatSystemNotificationTypeMemberInviteReject = 2,
    kNIMQChatSystemNotificationTypeMemberApply = 3,
    kNIMQChatSystemNotificationTypeMemberApplyReject = 4,
    kNIMQChatSystemNotificationTypeServerCreate = 5,
    kNIMQChatSystemNotificationTypeServerRemove = 6,
    kNIMQChatSystemNotificationTypeServerUpdate = 7,
    kNIMQChatSystemNotificationTypeMemberInviteDone = 8,
    kNIMQChatSystemNotificationTypeMemberInviteAccept = 9,
    kNIMQChatSystemNotificationTypeMemberApplyDone = 10,
    kNIMQChatSystemNotificationTypeMemberApplyAccept = 11,
    kNIMQChatSystemNotificationTypeMemberKick = 12,
    kNIMQChatSystemNotificationTypeMemberLeave = 13,
    kNIMQChatSystemNotificationTypeMemberUpdate = 14,
    kNIMQChatSystemNotificationTypeChannelCreate = 15,
    kNIMQChatSystemNotificationTypeChannelDelete = 16,
    kNIMQChatSystemNotificationTypeChannelUpdate = 17,
    kNIMQChatSystemNotificationTypeWhiteBlackRoleUpdate = 18,
    kNIMQChatSystemNotificationTypeWhiteBlackMembersUpdate = 19,
    kNIMQChatSystemNotificationTypeQuickCommentChanged = 20,
    kNIMQChatSystemNotificationTypeChannelCategoryCreate = 21,
    kNIMQChatSystemNotificationTypeChannelCategoryRemove = 22,
    kNIMQChatSystemNotificationTypeChannelCategoryUpdate = 23,
    kNIMQChatSystemNotificationTypeChannelCategoryWhiteBlackRoleUpdate = 24,
    kNIMQChatSystemNotificationTypeChannelCategoryWhiteBlackMembersUpdate = 25,
    kNIMQChatSystemNotificationTypeServerRoleAddMember = 26,
    kNIMQChatSystemNotificationTypeServerRoleRemoveMember = 27,
    kNIMQChatSystemNotificationTypeServerRolePermissionChange = 28,
    kNIMQChatSystemNotificationTypeChannelRolePermissionChange = 29,
    kNIMQChatSystemNotificationTypeMemberRolePermissionChange = 30,
    kNIMQChatSystemNotificationTypeChannelVisibilityChange = 31,
    kNIMQChatSystemNotificationTypeServerEnterLeave = 32,
    kNIMQChatSystemNotificationTypeServerJoinByInviteCode = 33,
    kNIMQChatSystemNotificationTypeChannelVisitorVisibilityChange = 34,
    kNIMQChatSystemNotificationTypeMyMemberInfoUpdated = 35,
    kNIMQChatSystemNotificationTypeCustom = 100
};
 
struct NIMQChatSystemNotificationMarkReadInfo {
    uint64_t msg_server_id;
    NIMQChatSystemNotificationType msg_type;
};
 
enum NIMQChatSystemNotificationStatus {
    kNIMQChatSystemNotificationNormal,
    kNIMQChatSystemNotificationUser = 10000  // 大于10000为用户自定义状态
};
 
struct NIMQChatSystemNotification {
    NIMQChatSystemNotificationToType to_type;
    uint64_t server_id;
    uint64_t channel_id;
    NIMQChatSystemNotificationType msg_type;
    char* msg_body;
    char* msg_attach;
    char* msg_ext;
    bool resend_flag;
    char* to_accids;
    bool history_enable;
    char* push_payload;
    char* push_content;
    bool push_enable;
    bool need_badge;
    bool need_push_nick;
    bool route_enable;
    char* env;
    // 以下字段仅在收到消息时有效
    NIMQChatSystemNotificationStatus status;
    char* msg_id;
    uint64_t msg_server_id;
    char* from_accid;
    uint32_t from_client_type;
    char* from_device_id;
    char* from_nick;
    uint64_t timestamp;
    uint64_t update_timestamp;
    void* msg_data;
    char* callback_ext;
};
 
struct NIMQChatTypingEvent {
    uint64_t server_id;
    uint64_t channel_id;
    char* extension;
    // 以下字段仅在收到事件时有效
    char* from_accid;
    char* from_nick;
    uint64_t timestamp;
};
 
struct NIMQChatSystemNotificationDataServerInvite {
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataServerInviteReject {
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataServerApply {
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataServerApplyReject {
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataServerCreate {
    NIMQChatServerInfo server_info;
};
 
struct NIMQChatSystemNotificationDataServerUpdate {
    NIMQChatServerInfo server_info;
};
 
struct NIMQChatSystemNotificationDataChannelCreate {
    NIMQChatChannelInfo channel_info;
};
 
struct NIMQChatSystemNotificationDataChannelUpdate {
    NIMQChatChannelInfo channel_info;
};
 
struct NIMQChatSystemNotificationDataMemberInviteDone {
    NIMQChatServerInfo server_info;
    char* invite_accids;
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataMemberInviteAccept {
    NIMQChatServerInfo server_info;
    char* invite_accid;
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataMemberApplyDone {
    NIMQChatServerInfo server_info;
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataMemberApplyAccept {
    NIMQChatServerInfo server_info;
    char* apply_accid;
    uint64_t request_id;
};
 
struct NIMQChatSystemNotificationDataMemberKick {
    NIMQChatServerInfo server_info;
    char* kick_accids;
};
 
struct NIMQChatSystemNotificationDataMemberLeave {
    NIMQChatServerInfo server_info;
};
 
struct NIMQChatSystemNotificationDataMemberUpdate {
    NIMQChatMemberInfo member_info;
};
 
struct NIMQChatSystemNotificationDataWhiteBlackRoleUpdate {
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t role_id;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatSystemNotificationDataWhiteBlackMembersUpdate {
    uint64_t server_id;
    uint64_t channel_id;
    char** accids;
    size_t accids_count;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatSystemNotificationDataQuickCommentChanged {
    uint64_t server_id;
    uint64_t channel_id;
    char* msg_sender_accid;
    uint64_t msg_server_id;
    uint64_t msg_timestamp;
    uint64_t type;
    NIMQChatQuickCommentOperation operate_type;
    char* operator_accid;
};
 
struct NIMQChatSystemNotificationDataChannelCategoryCreate {
    NIMQChatChannelCategoryInfo category_info;
};
 
struct NIMQChatSystemNotificationDataChannelCategoryRemove {
    uint64_t category_id;
};
 
typedef NIMQChatSystemNotificationDataChannelCategoryCreate NIMQChatSystemNotificationDataChannelCategoryUpdate;
 
struct NIMQChatSystemNotificationDataChannelCategoryWhiteBlackRoleUpdate {
    uint64_t server_id;
    uint64_t category_id;
    uint64_t role_id;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatSystemNotificationDataChannelCategoryWhiteBlackMembersUpdate {
    uint64_t server_id;
    uint64_t category_id;
    char** accids;
    size_t accids_count;
    NIMQChatChannelWhiteBlackType type;
    NIMQChatChannelWhiteBlackOpeType ope_type;
};
 
struct NIMQChatSystemNotificationDataServerRoleAddMember {
    uint64_t server_id;
    uint64_t role_id;
    char** accids;
    size_t accids_count;
};
 
typedef NIMQChatSystemNotificationDataServerRoleAddMember NIMQChatSystemNotificationDataServerRoleRemoveMember;
 
struct NIMQChatSystemNotificationDataServerRolePermissionChange {
    uint64_t server_id;
    uint64_t role_id;
    NIMQChatPermissionGroup* permissions;
    size_t permissions_count;
};
 
struct NIMQChatSystemNotificationDataChannelRolePermissionChange {
    uint64_t server_id;
    uint64_t channel_id;
    uint64_t parent_role_id;
    uint64_t role_id;
    NIMQChatPermissionGroup* permissions;
    size_t permissions_count;
};
 
struct NIMQChatSystemNotificationDataMemberRolePermissionChange {
    uint64_t server_id;
    uint64_t channel_id;
    char* accid;
    NIMQChatPermissionGroup* permissions;
    size_t permissions_count;
};
 
struct NIMQChatSystemNotificationDataChannelVisibilityChange {
    bool visible;
};
 
struct NIMQChatSystemNotificationDataServerEnterLeave {
    bool is_enter;
};
 
struct NIMQChatSystemNotificationDataServerJoinByInviteCode {
    NIMQChatServerInfo server_info;
    uint64_t request_id;
    char* invite_code;
};
 
struct NIMQChatSystemNotificationDataChannelVisitorVisibilityChange {
    bool visible;
};
 
struct NIMQChatUpdatedMyMemberInfo {
    uint64_t server_id;
    char* nick;
    char* avatar;
};
 
struct NIMQChatSystemNotificationDataMyMemberInfoUpdated {
    NIMQChatUpdatedMyMemberInfo* updated_infos;
    size_t updated_infos_count;
};
 
struct NIMQChatRecvSystemNotificationResp {
    void* user_data;
    NIMQChatSystemNotification notification;
    bool is_leave;
};
 
struct NIMQChatSystemNotificationUpdatedResp {
    void* user_data;
    NIMQChatMessageUpdateInfo update_info;
    NIMQChatSystemNotification notification;
};
 
struct NIMQChatSendSystemNotificationResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatSystemNotification notification;
};
 
struct NIMQChatUpdateSystemNotificationResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatSystemNotification notification;
};
 
typedef NIMQChatBaseResp NIMQChatMarkReadSystemNotificationResp;
 
struct NIMQChatRecvTypingEventResp {
    void* user_data;
    NIMQChatTypingEvent typing_event;
};
 
struct NIMQChatSendTypingEventResp {
    uint32_t res_code;
    void* user_data;
    NIMQChatTypingEvent typing_event;
};
 
/* --------------------------------- 接口回调模板 -----------------------------*/
 
typedef void (*nim_qchat_recv_notification_cb_func)(const NIMQChatRecvSystemNotificationResp* resp);
typedef void (*nim_qchat_notification_updated_cb_func)(const NIMQChatSystemNotificationUpdatedResp* resp);
typedef void (*nim_qchat_send_notification_cb_func)(const NIMQChatSendSystemNotificationResp* resp);
typedef void (*nim_qchat_update_notification_cb_func)(const NIMQChatUpdateSystemNotificationResp* resp);
typedef void (*nim_qchat_mark_read_notification_cb_func)(const NIMQChatMarkReadSystemNotificationResp* resp);
typedef void (*nim_qchat_recv_typing_event_cb_func)(const NIMQChatRecvTypingEventResp* resp);
typedef void (*nim_qchat_send_typing_event_cb_func)(const NIMQChatSendTypingEventResp* resp);
 
/* --------------------------------- 接口调用参数 ------------------------------- */
 
struct NIMQChatRegRecvSystemNotificationCbParam {
    nim_qchat_recv_notification_cb_func cb;
    void* user_data;
};
 
struct NIMQChatRegSystemNotificationUpdatedCbParam {
    nim_qchat_notification_updated_cb_func cb;
    void* user_data;
};
 
struct NIMQChatSendSystemNotificationParam {
    nim_qchat_send_notification_cb_func cb;
    void* user_data;
    NIMQChatSystemNotification notification;
};
 
struct NIMQChatUpdateSystemNotificationParam {
    nim_qchat_update_notification_cb_func cb;
    void* user_data;
    uint64_t msg_server_id;
    NIMQChatSystemNotificationType msg_type;
    NIMQChatSystemNotificationStatus status;
    char* msg_body;
    char* msg_ext;
    NIMQChatMessageUpdateInfo update_info;
};
 
struct NIMQChatMarkSystemNotificationsReadParam {
    nim_qchat_mark_read_notification_cb_func cb;
    void* user_data;
    size_t mark_read_infos_count;
    NIMQChatSystemNotificationMarkReadInfo* mark_read_infos;
};
 
struct NIMQChatRegRecvTypingEventCbParam {
    nim_qchat_recv_typing_event_cb_func cb;
    void* user_data;
};
 
struct NIMQChatSendTypingEventParam {
    nim_qchat_send_typing_event_cb_func cb;
    void* user_data;
    NIMQChatTypingEvent typing_event;
};
 
#ifdef __cplusplus
}
#endif
 
#endif  // __NIM_QCHAT_SYSTEM_NOTIFICATION_DEF_H__