NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim_qchat_client_def.h 文件参考

浏览源代码.

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
 圈组协议加密配置 更多...
 
struct  NIMQChatFCSConfiguration
 圈组云端数据存储配置信息 更多...
 
struct  NIMQChatMessageCacheConfiguration
 
struct  NIMQChatInitParam
 
struct  NIMQChatCleanupParam
 
struct  NIMQChatLoginParam
 
struct  NIMQChatLogoutParam
 
struct  NIMQChatKickParam
 
struct  NIMQChatRegSDKLogCbParam
 
struct  NIMQChatGetRTCTokenParam
 

类型定义

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回调
 

枚举

enum  NIMQChatLoginAuthType { kNIMQChatLoginAuthTypeDefault = 0 , kNIMQChatLoginAuthTypeAppSecret = 1 , kNIMQChatLoginAuthTypeAppThirdParty = 2 }
 
enum  NIMQChatClientType {
  kQChatClientTypeUnknown = 0 , kQChatClientTypeAOS = 1 , kQChatClientTypeIOS = 2 , kQChatClientTypePC = 4 ,
  kQChatClientTypeWP = 8 , kQChatClientTypeWeb = 16 , kQChatClientTypeMacOS = 64 , kQChatClientTypeHarmonyOS = 128
}
 
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 }
 

详细描述

作者
NetEase Yunxin
版本
0.1
日期
2022-01-17

类型定义说明

◆ nim_qchat_custom_token_cb_func

typedef NIMQChatCustomTokenResp(* nim_qchat_custom_token_cb_func) (const NIMQChatCustomTokenResp *resp)

获取自定义token回调

◆ nim_qchat_get_rtc_token_cb_func

typedef void(* nim_qchat_get_rtc_token_cb_func) (const NIMQChatGetRTCTokenResp *resp)

获取RTC token回调

◆ nim_qchat_kick_cb_func

typedef void(* nim_qchat_kick_cb_func) (const NIMQChatKickResp *resp)

踢掉其他端回调

◆ nim_qchat_kicked_cb_func

typedef void(* nim_qchat_kicked_cb_func) (const NIMQChatKickedResp *resp)

接收被踢回调

◆ nim_qchat_login_cb_func

typedef void(* nim_qchat_login_cb_func) (const NIMQChatLoginResp *resp)

登录回调

◆ nim_qchat_login_status_cb_func

typedef void(* nim_qchat_login_status_cb_func) (const NIMQChatLoginStatusResp *resp)

登录状态回调

◆ nim_qchat_logout_cb_func

typedef void(* nim_qchat_logout_cb_func) (const NIMQChatLogoutResp *resp)

登出回调

◆ nim_qchat_multispot_login_cb_func

typedef void(* nim_qchat_multispot_login_cb_func) (const NIMQChatMultispotLoginResp *resp)

多端登录回调

◆ nim_qchat_sdk_log_cb_func

typedef void(* nim_qchat_sdk_log_cb_func) (const NIMQChatSDKLogResp *resp)

SDK日志回调

枚举类型说明

◆ NIMQChatClientType

枚举值
kQChatClientTypeUnknown 
kQChatClientTypeAOS 

Android

kQChatClientTypeIOS 

iOS

kQChatClientTypePC 

Desktop PC (Windows/macOS/Linux)

kQChatClientTypeWP 

WP

kQChatClientTypeWeb 

Web

kQChatClientTypeMacOS 

macOS

kQChatClientTypeHarmonyOS 

HarmonyOS

◆ NIMQChatCommEncryptionAlgorithm

枚举值
kNIMQChatCommEncryptionAlgorithmBase 
kNIMQChatCommEncryptionAlgorithmRC4 

RC4 加密

kNIMQChatCommEncryptionAlgorithmAES128 

AES128 加密

kNIMQChatCommEncryptionAlgorithmSM4 

◆ NIMQChatExchangeKeyEncryptionAlgorithm

枚举值
kNIMQChatEncryptionAlgorithmRSA 

RSA 加密

kNIMQChatEncryptionAlgorithmSM2 

SM2 加密

◆ NIMQChatFCSAuthenticationType

枚举值
kNIMQChatFCSAuthenticationTypeRefer 
kNIMQChatFCSAuthenticationTypeToken 
kNIMQChatFCSAuthenticationTypeURLToken 
kNIMQChatFCSAuthenticationTypeCustom 

◆ NIMQChatHandShakeType

枚举值
kNIMQChatHandShakeTypeMulti 

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

kNIMQChatHandShakeTypeRASRC4 

◆ NIMQChatLoginAuthType

圈组登录鉴权类型

枚举值
kNIMQChatLoginAuthTypeDefault 

默认login token鉴权方式

kNIMQChatLoginAuthTypeAppSecret 

app secret鉴权方式

kNIMQChatLoginAuthTypeAppThirdParty 

基于第三方回调的token鉴权方式, 圈组暂不支持

◆ NIMQChatLoginStatus

枚举值
kLoginStatusUnlogin 
kLoginStatusLogging 
kLoginStatusLogin 
kLoginStatusKicked 

◆ NIMQChatLoginStep

枚举值
kLoginStepLink 

连接 Link 地址阶段

kLoginStepAuth