nim_qchat_client_def.h File Reference

#include "nim_qchat_public_def.h"

Go to the source code of this file.

Classes
struct	NIMQChatLoginClientInfo
struct	NIMQChatKickedResp
struct	NIMQChatLoginStatusResp
struct	NIMQChatCustomTokenResp
struct	NIMQChatMultispotLoginResp
struct	NIMQChatSDKLogResp
struct	NIMQChatLoginResp
struct	NIMQChatLogoutResp
struct	NIMQChatKickResp
struct	NIMQChatGetRTCTokenResp
struct	NIMQChatRegCustomTokenCbParam
struct	NIMQChatRegKickedCbParam
struct	NIMQChatRegLoginStatusCbParam
struct	NIMQChatRegMultispotLoginCbParam
struct	NIMQChatEncryptionConfiguration
	圈组协议加密配置 More...
struct	NIMQChatFCSConfiguration
	圈组云端数据存储配置信息 More...
struct	NIMQChatMessageChacheConfiguration
struct	NIMQChatInitParam
struct	NIMQChatCleanupParam
struct	NIMQChatLoginParam
struct	NIMQChatLogoutParam
struct	NIMQChatKickParam
struct	NIMQChatRegSDKLogCbParam
struct	NIMQChatGetRTCTokenParam

Typedefs
typedef NIMQChatCustomTokenResp(*	nim_qchat_custom_token_cb_func) (const NIMQChatCustomTokenResp &resp)
	获取自定义token回调
typedef void(*	nim_qchat_kicked_cb_func) (const NIMQChatKickedResp &resp)
	接收被踢回调
typedef void(*	nim_qchat_login_status_cb_func) (const NIMQChatLoginStatusResp &resp)
	登录状态回调
typedef void(*	nim_qchat_multispot_login_cb_func) (const NIMQChatMultispotLoginResp &resp)
	多端登录回调
typedef void(*	nim_qchat_sdk_log_cb_func) (const NIMQChatSDKLogResp &resp)
	SDK日志回调
typedef void(*	nim_qchat_login_cb_func) (const NIMQChatLoginResp &resp)
	登录回调
typedef void(*	nim_qchat_logout_cb_func) (const NIMQChatLogoutResp &resp)
	登出回调
typedef void(*	nim_qchat_kick_cb_func) (const NIMQChatKickResp &resp)
	踢掉其他端回调
typedef void(*	nim_qchat_get_rtc_token_cb_func) (const NIMQChatGetRTCTokenResp &resp)
	获取RTC token回调

Enumerations
enum	NIMQChatLoginAuthType { kNIMQChatLoginAuthTypeDefault = 0 , kNIMQChatLoginAuthTypeAppSecret = 1 , kNIMQChatLoginAuthTypeAppThirdParty = 2 }
enum	NIMQChatClientType {   kQChatClientTypeUnknown = 0 , kQChatClientTypeAOS = 1 , kQChatClientTypeIOS = 2 , kQChatClientTypePC = 4 ,   kQChatClientTypeWP = 8 , kQChatClientTypeWeb = 16 , kQChatClientTypeMacOS = 64 }
enum	NIMQChatLoginStep { kLoginStepLink , kLoginStepAuth }
enum	NIMQChatLoginStatus { kLoginStatusUnlogin = 0 , kLoginStatusLogging = 1 , kLoginStatusLogin = 2 , kLoginStatusKicked = 3 }
enum	NIMQChatExchangeKeyEncryptionAlgorithm { kNIMQChatEncryptionAlgorithmRSA = 1 , kNIMQChatEncryptionAlgorithmSM2 = 2 }
enum	NIMQChatCommEncryptionAlgorithm { kNIMQChatCommEncryptionAlgorithmBase = 1 , kNIMQChatCommEncryptionAlgorithmRC4 = kNIMQChatCommEncryptionAlgorithmBase , kNIMQChatCommEncryptionAlgorithmAES128 = kNIMQChatCommEncryptionAlgorithmBase << 1 , kNIMQChatCommEncryptionAlgorithmSM4 = kNIMQChatCommEncryptionAlgorithmBase << 2 }
enum	NIMQChatHandShakeType { kNIMQChatHandShakeTypeMulti = 0 , kNIMQChatHandShakeTypeRASRC4 }
enum	NIMQChatFCSAuthenticationType { kNIMQChatFCSAuthenticationTypeRefer = 1 , kNIMQChatFCSAuthenticationTypeToken , kNIMQChatFCSAuthenticationTypeURLToken , kNIMQChatFCSAuthenticationTypeCustom }

Detailed Description

Author

NetEase Yunxin

Version

0.1

Date

2022-01-17

Copyright

(c) 2022, NetEase Inc. All rights reserved

Enumeration Type Documentation

NIMQChatClientType

enum NIMQChatClientType

Enumerator
kQChatClientTypeAOS	Android.
kQChatClientTypeIOS	iOS
kQChatClientTypePC	Desktop PC (Windows/macOS/Linux)
kQChatClientTypeWP	WP.
kQChatClientTypeWeb	Web.
kQChatClientTypeMacOS	macOS

NIMQChatCommEncryptionAlgorithm

enum NIMQChatCommEncryptionAlgorithm

Enumerator
kNIMQChatCommEncryptionAlgorithmRC4	RC4 加密
kNIMQChatCommEncryptionAlgorithmAES128	AES128 加密

NIMQChatExchangeKeyEncryptionAlgorithm

enum NIMQChatExchangeKeyEncryptionAlgorithm

Enumerator
kNIMQChatEncryptionAlgorithmRSA	RSA 加密
kNIMQChatEncryptionAlgorithmSM2	SM2 加密

NIMQChatHandShakeType

enum NIMQChatHandShakeType

Enumerator
kNIMQChatHandShakeTypeMulti	支持配置多种对称与非对称加密算法

NIMQChatLoginAuthType

enum NIMQChatLoginAuthType

圈组登录鉴权类型

Enumerator
kNIMQChatLoginAuthTypeDefault	默认login token鉴权方式
kNIMQChatLoginAuthTypeAppSecret	app secret鉴权方式
kNIMQChatLoginAuthTypeAppThirdParty	基于第三方回调的token鉴权方式, 圈组暂不支持

NIMQChatLoginStep

enum NIMQChatLoginStep

Enumerator
kLoginStepLink	连接 Link 地址阶段