nim_qchat_server_def.h File Reference

#include "nim_qchat_member_def.h"
#include "nim_qchat_public_def.h"

Go to the source code of this file.

Classes
struct	NIMQChatServerInfo
struct	NIMQChatApplyInfoData
struct	NIMQChatInviteUserInfo
struct	NIMQChatInviteInfoData
struct	NIMQChatBeInvitedInfoData
struct	NIMQChatGenerateInviteCodeInfoData
struct	NIMQChatJoinByInviteCodeInfoData
struct	NIMQChatInviteApplyRecord
struct	NIMQChatServerCreateResp
struct	NIMQChatServerGetServersResp
struct	NIMQChatServerGetServersPageResp
struct	NIMQChatServerInviteResp
struct	NIMQChatServerApplyResp
struct	NIMQChatServerGetMembersResp
struct	NIMQChatServerGetMembersPageResp
struct	NIMQChatServerSubscribeResp
struct	NIMQChatServerGetBannedMembersPageResp
struct	NIMQChatServerUnreadResp
struct	NIMQChatServerGenerateInviteCodeResp
struct	NIMQChatServerGetInviteApplyRecordOfServerResp
struct	NIMQChatServerMarkReadResp
struct	NIMQChatServerSubscribeAllChannelResp
struct	NIMQChatServerRegUnreadCbParam
struct	NIMQChatServerCreateParam
struct	NIMQChatServerDeleteParam
struct	NIMQChatServerUpdateParam
struct	NIMQChatServerGetServersParam
struct	NIMQChatServerGetServersPageParam
struct	NIMQChatServerInviteParam
struct	NIMQChatServerAcceptInviteParam
struct	NIMQChatServerRejectInviteParam
struct	NIMQChatServerApplyParam
struct	NIMQChatServerAcceptApplyParam
struct	NIMQChatServerRejectApplyParam
struct	NIMQChatServerKickParam
struct	NIMQChatServerLeaveParam
struct	NIMQChatServerUpdateMemberInfoParam
struct	NIMQChatServerMemberPair
struct	NIMQChatServerGetMembersParam
struct	NIMQChatServerGetMembersPageParam
struct	NIMQChatServerSubscribeParam
struct	NIMQChatServerBanMemberParam
struct	NIMQChatServerUnbanMemberParam
struct	NIMQChatServerGetBannedMembersPageParam
struct	NIMQChatServerSearchPageParam
struct	NIMQChatServerMemberSearchParam
struct	NIMQChatServerGenerateInviteCodeParam
struct	NIMQChatServerJoinByInviteCodeParam
struct	NIMQChatServerGetInviteApplyRecordOfServerParam
struct	NIMQChatServerGetInviteApplyRecordOfSelfParam
struct	NIMQChatServerMarkReadParam
struct	NIMQChatServerSubscribeAllChannelParam

Typedefs
typedef NIMQChatBaseResp	NIMQChatServerDeleteResp
typedef NIMQChatServerCreateResp	NIMQChatServerUpdateResp
typedef NIMQChatBaseResp	NIMQChatServerAcceptInviteResp
typedef NIMQChatBaseResp	NIMQChatServerRejectInviteResp
typedef NIMQChatBaseResp	NIMQChatServerAcceptApplyResp
typedef NIMQChatBaseResp	NIMQChatServerRejectApplyResp
typedef NIMQChatBaseResp	NIMQChatServerKickResp
typedef NIMQChatBaseResp	NIMQChatServerLeaveResp
typedef NIMQChatBaseResp	NIMQChatServerUpdateMemberInfoResp
typedef NIMQChatBaseResp	NIMQChatServerBanMemberResp
typedef NIMQChatBaseResp	NIMQChatServerUnbanMemberResp
typedef NIMQChatServerGetServersPageResp	NIMQChatServerSearchPageResp
typedef NIMQChatServerGetMembersResp	NIMQChatServerMemberSearchResp
typedef NIMQChatBaseResp	NIMQChatServerJoinByInviteCodeResp
typedef NIMQChatServerGetInviteApplyRecordOfServerResp	NIMQChatServerGetInviteApplyRecordOfSelfResp
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)
	订阅所有频道

Enumerations
enum	NIMQChatServerInviteMode { kNIMQChatServerInviteModeNeedConfirm , kNIMQChatServerInviteModeNormal }
enum	NIMQChatServerApplyMode { kNIMQChatServerApplyModeNormal , kNIMQChatServerApplyModeNeedConfirm }
enum	NIMQChatServerInviteFailReason { kNIMQChatServerInviteFailReasonExceedLimit = 1 , kNIMQChatServerInviteFailReasonBanned = 2 }
enum	NIMQChatServerSearchType { kNIMQChatServerSearchTypeSquare = 1 , kNIMQChatServerSearchTypePersonal = 2 }
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 }

Detailed Description

Author

NetEase Yunxin

Version

0.1

Date

2022-01-17

Copyright

(c) 2022, NetEase Inc. All rights reserved

Enumeration Type Documentation

NIMQChatInviteApplyRecordStatus

enum NIMQChatInviteApplyRecordStatus

Enumerator
kNIMQChatInviteApplyRecordStatusInitial	初始状态
kNIMQChatInviteApplyRecordStatusApprove	同意
kNIMQChatInviteApplyRecordStatusReject	拒绝
kNIMQChatInviteApplyRecordStatusApproveByOtherRequest	通过其他请求同意
kNIMQChatInviteApplyRecordStatusRejectByOtherRequest	通过其他请求拒绝
kNIMQChatInviteApplyRecordStatusAutoJoin	邀请/申请时自动加入
kNIMQChatInviteApplyRecordStatusExpired	过期

NIMQChatInviteApplyRecordType

enum NIMQChatInviteApplyRecordType

Enumerator
kNIMQChatInviteApplyRecordTypeApply	申请
kNIMQChatInviteApplyRecordTypeInvite	邀请
kNIMQChatInviteApplyRecordTypeBeInvited	被邀请
kNIMQChatInviteApplyRecordTypeGenerateInviteCode	生成邀请码
kNIMQChatInviteApplyRecordTypeJoinByInviteCode	通过邀请码加入

NIMQChatServerApplyMode

enum NIMQChatServerApplyMode

Enumerator
kNIMQChatServerApplyModeNormal	不需要验证
kNIMQChatServerApplyModeNeedConfirm	需要验证

NIMQChatServerInviteFailReason

enum NIMQChatServerInviteFailReason

Enumerator
kNIMQChatServerInviteFailReasonExceedLimit	服务器人数超过限制
kNIMQChatServerInviteFailReasonBanned	被封禁

NIMQChatServerInviteMode

enum NIMQChatServerInviteMode

Enumerator
kNIMQChatServerInviteModeNeedConfirm	需要验证

NIMQChatServerSearchType

enum NIMQChatServerSearchType

Enumerator
kNIMQChatServerSearchTypeSquare	广场搜索
kNIMQChatServerSearchTypePersonal	个人服务器搜索