nim_qchat.h File Reference

圈组 接口头文件，在需要使用圈组 SDK 的地方包含该头文件即可 More...

#include "nim_qchat_defines/nim_qchat_client_def.h"
#include "public_defines.h"

Go to the source code of this file.

Functions
NIM_SDK_DLL_API void	nim_qchat_reg_custom_token_cb (const NIMQChatRegCustomTokenCbParam &param)
	注册自定义token获取回调，用于登录类型不为静态token时，获取token More...
NIM_SDK_DLL_API void	nim_qchat_reg_kicked_out_cb (const NIMQChatRegKickedCbParam &param)
	注册被踢回调 More...
NIM_SDK_DLL_API void	nim_qchat_reg_login_status_cb (const NIMQChatRegLoginStatusCbParam &param)
	注册登录状态回调 More...
NIM_SDK_DLL_API void	nim_qchat_reg_multispot_login_cb (const NIMQChatRegMultispotLoginCbParam &param)
	注册多端登录通知回调 More...
NIM_SDK_DLL_API void	nim_qchat_reg_sdk_log_cb (const NIMQChatRegSDKLogCbParam &param)
NIM_SDK_DLL_API void	nim_qchat_init (const NIMQChatInitParam &param)
	圈组模块初始化(SDK初始化时调用一次) More...
NIM_SDK_DLL_API void	nim_qchat_cleanup (const NIMQChatCleanupParam &param)
	圈组模块清理(卸载SDK时调用一次) More...
NIM_SDK_DLL_API void	nim_qchat_login (const NIMQChatLoginParam &param)
	登录圈组 More...
NIM_SDK_DLL_API void	nim_qchat_logout (const NIMQChatLogoutParam &param)
	登出圈组 More...
NIM_SDK_DLL_API void	nim_qchat_kick_other_clients (const NIMQChatKickParam &param)
	踢掉自己其他端 More...

Detailed Description

圈组 接口头文件，在需要使用圈组 SDK 的地方包含该头文件即可

Copyright

Copyright (c) 2021, NetEase Inc. All rights reserved

Author

Zvicii

Date

2021/12/27

Function Documentation

nim_qchat_cleanup()

void nim_qchat_cleanup

(

const NIMQChatCleanupParam &

param

)

圈组模块清理(卸载SDK时调用一次)

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_init()

void nim_qchat_init

(

const NIMQChatInitParam &

param

)

圈组模块初始化(SDK初始化时调用一次)

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_kick_other_clients()

void nim_qchat_kick_other_clients

(

const NIMQChatKickParam &

param

)

踢掉自己其他端

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_login()

void nim_qchat_login

(

const NIMQChatLoginParam &

param

)

登录圈组

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_logout()

void nim_qchat_logout

(

const NIMQChatLogoutParam &

param

)

登出圈组

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_reg_custom_token_cb()

void nim_qchat_reg_custom_token_cb

(

const NIMQChatRegCustomTokenCbParam &

param

)

注册自定义token获取回调，用于登录类型不为静态token时，获取token

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_reg_kicked_out_cb()

void nim_qchat_reg_kicked_out_cb

(

const NIMQChatRegKickedCbParam &

param

)

注册被踢回调

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_reg_login_status_cb()

void nim_qchat_reg_login_status_cb

(

const NIMQChatRegLoginStatusCbParam &

param

)

注册登录状态回调

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_reg_multispot_login_cb()

void nim_qchat_reg_multispot_login_cb

(

const NIMQChatRegMultispotLoginCbParam &

param

)

注册多端登录通知回调

Parameters

[in]

param

接口参数

Returns

void

nim_qchat_reg_sdk_log_cb()

void nim_qchat_reg_sdk_log_cb

(

const NIMQChatRegSDKLogCbParam &

param

)

SDK系统日志回调，可用于动态获取日志，不建议用于生产环境

Parameters

[in]	cb	回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值