辅助能力接口相关的常量函数等定义头文件 More...

#include "nim_res_code_def.h"
#include "public_defines.h"

Typedefs
typedef void(*	nim_json_transport_cb_func) (const char json_params, const void user_data)

typedef void(*	nim_relogin_request_token_cb_func) (char &auth_token, uint32_t length, const char json_params, const void user_data)

typedef void(*	nim_sdk_log_cb_func) (int log_level, const char log, const void user_data)

typedef void(*	nim_sdk_exception_cb_func) (enum NIMSDKException exception, const char log, const void user_data)

typedef void(*	nim_sdk_get_cache_file_info_cb_func) (const char info, const void user_data)

typedef void(*	nim_sdk_del_cache_file_cb_func) (enum NIMResCode rescode, const void *user_data)

typedef void(*	nim_sdk_feedback_cb_func) (enum NIMResCode rescode, const void *user_data)

typedef void(*	nim_global_sdk_db_error_cb_func) (const char error_info, const void user_data)

typedef void(*	nim_global_upload_sdk_log_cb_func) (int rescode, const void *user_data)

typedef void(*	nim_global_detect_proxy_cb_func) (bool network_connect, enum NIMProxyDetectStep step, const char json_params, const void user_data)

Enumerations
enum	NIMSDKLogLevel { kNIMSDKLogLevelFatal = 1 , kNIMSDKLogLevelError = 2 , kNIMSDKLogLevelWarn = 3 , kNIMSDKLogLevelApp = 5 , kNIMSDKLogLevelPro = 6 , kNIMSDKLogLevelFatal = 1 , kNIMSDKLogLevelError = 2 , kNIMSDKLogLevelWarn = 3 , kNIMSDKLogLevelApp = 5 , kNIMSDKLogLevelPro = 6 }

enum	NIMSDKException { kNIMSDKExceptionSpaceEmpty = 1 }

enum	NIMDBOperation { kNIMDBOperationInsert = 0x0001 , kNIMDBOperationRead = 0x0002 , kNIMDBOperationUpdate = 0x0004 , kNIMDBOperationDelete = 0x0008 }

enum	NIMProxyDetectStep { kNIMProxyDetectStepAllComplete = 5 }

enum	NIMProxyType { kNIMProxyNone = 0 , kNIMProxyHttp11 = 1 , kNIMProxySocks4 = 4 , kNIMProxySocks4a = 5 , kNIMProxySocks5 = 6 , kNIMProxyNrtc = 10 , kNIMProxyNone = 0 , kNIMProxyHttp11 = 1 , kNIMProxySocks4 = 4 , kNIMProxySocks4a = 5 , kNIMProxySocks5 = 6 , kNIMProxySocks5HostName = 7 }

Variables
json params for NIMResCode, see nim_res_code_def.h
static const char *	kNIMResCode = "err_code"
	int, NIMResCode

查询SDK文件缓存信息回调info结构定义
static const char *	kNIMCacheFileType = "file_type"
	string,文件类型

static const char *	kNIMCacheFileCount = "file_count"
	int,文件数量

static const char *	kNIMCacheFilePath = "file_path"
	string,文件所在文件夹路径

static const char *	kNIMCacheFileTotalSize = "total_size"
	int64,文件总大小KB

查询SDK文件缓存信息文件类型file_type
static const char *	kNIMCacheFileOther = "res"
	杂项文件缓存

static const char *	kNIMCacheFileImage = "image"
	图片消息缓存

static const char *	kNIMCacheFileAudio = "audio"
	语音消息缓存

static const char *	kNIMCacheFileVideo = "video"
	视频消息缓存

获取客户端灰度配置协议AppGrayConfigTag
static const char *	kNIMGrayMixStoreEnable = "mixStoreEnable"
	bool, 是否开启融合存储

static const char *	kNIMGrayTestEnable = "testEnbale"
	bool, 是否开启测试

SDK DB操作出错时的反馈回调数据 error_info
static const char *	kNIMDBErrDBName = "db_name"
	出错DB的名称

static const char *	kNIMDBERROperation = "operation"
	出错DB的操作(读、写、更新、删除)

static const char *	kNIMDBErrCode = "error_code"
	错误码

static const char *	kNIMDBErrDescription_ = "error_description"
	相应的错误描述

static const char *	kNIMDBErrAttach = "error_attach"
	具体的出错信息

Detailed Description

辅助能力接口相关的常量函数等定义头文件

Copyright: (c) 2015-2017, NetEase Inc. All rights reserved

Author: Harrison

Date: 2015/2/1

Typedef Documentation

◆ nim_global_detect_proxy_cb_func

void(* nim_global_detect_proxy_cb_func)(bool network_connect, NIMProxyDetectStep step, const char *network_log, const void *user_data)

探测代理回调

Parameters

[out]	network_connect	探测结果
[out]	step	探测步骤
[out]	json_params	输出的json字符串内容
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns: void 无返回值

◆ nim_global_sdk_db_error_cb_func

void(* nim_global_sdk_db_error_cb_func)(const char *error_info)

SDK DB操作出错时的反馈回调

Parameters

[out]	error_info	错误的相关信息
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns: void 无返回值

◆ nim_global_upload_sdk_log_cb_func

void(* nim_global_upload_sdk_log_cb_func)(int rescode, const void *user_data)

上传SDK日志回调

Parameters

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

Returns: void 无返回值

◆ nim_json_transport_cb_func

void(* nim_json_transport_cb_func)(const char *json_params, const void *user_data)

nim callback function with json parameters from sdk and user's data from app

Parameters

[out]	json_params	输出的json字符串内容
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns: void 无返回值

◆ nim_relogin_request_token_cb_func

void(* nim_relogin_request_token_cb_func)(char *&auth_token, uint32_t *length, const char *json_params, const void *user_data)

登录时 auth type 不为 0 时触发断线重连的回调函数

Parameters

[in]	auth_token	新的 auth token
[in]	token	的长度
[out]	json_params	输出的json字符串内容
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns: void 无返回值

◆ nim_sdk_del_cache_file_cb_func

void(* nim_sdk_del_cache_file_cb_func)(enum NIMResCode rescode, const void *user_data)

删除sdk缓存文件回调

Parameters

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

Returns: void 无返回值

◆ nim_sdk_exception_cb_func

void(* nim_sdk_exception_cb_func)(enum NIMSDKException exception, const char *log, const void *user_data)

输出当前环境异常回调

Parameters

[out]	exception	见NIMSDKException
[out]	log	描述
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns: void 无返回值

◆ nim_sdk_feedback_cb_func

void(* nim_sdk_feedback_cb_func)(enum NIMResCode rescode, const void *user_data)

SDK反馈回调

Parameters

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

Returns: void 无返回值

◆ nim_sdk_get_cache_file_info_cb_func

void(* nim_sdk_get_cache_file_info_cb_func)(const char *info, const void *user_data)

获取sdk缓存文件信息回调

Parameters

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

Returns: void 无返回值

◆ nim_sdk_log_cb_func

void(* nim_sdk_log_cb_func)(int log_level, const char *log, const void *user_data)

输出sdk log回调

Parameters

[out]	log_level	log级别，见NIMSDKLogLevel
[out]	log	log内容
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns: void 无返回值

Enumeration Type Documentation

◆ NIMDBOperation

enum NIMDBOperation

对DB进行的操作类型

Enumerator
kNIMDBOperationInsert	写操作
kNIMDBOperationRead	读操作
kNIMDBOperationUpdate	更新操作
kNIMDBOperationDelete	删除操作

◆ NIMProxyDetectStep

enum NIMProxyDetectStep

代理测试步骤

Enumerator
kNIMProxyDetectStepAllComplete	探测代理有效性结束

◆ NIMProxyType

enum NIMProxyType

代理类型

Enumerator
kNIMProxyNone	不使用代理
kNIMProxyHttp11	HTTP 1.1 Proxy（暂不支持）
kNIMProxySocks4	Socks4 Proxy.
kNIMProxySocks4a	Socks4a Proxy.
kNIMProxySocks5	Socks5 Proxy.
kNIMProxyNrtc	云信音视频私有代理，只在nim_vchat_set_proxy中有效
kNIMProxyNone	不使用代理
kNIMProxyHttp11	HTTP 1.1 Proxy
kNIMProxySocks4	Socks4 Proxy
kNIMProxySocks4a	Socks4a Proxy
kNIMProxySocks5	Socks5 Proxy
kNIMProxySocks5HostName	Socks5 host Proxy

◆ NIMSDKException

enum NIMSDKException

异常

Enumerator
kNIMSDKExceptionSpaceEmpty	当前数据目录所在盘符空间紧张或用完, log: {"free_space" : lf, "message":""}, free_space单位M

◆ NIMSDKLogLevel

enum NIMSDKLogLevel

NIM SDK log级别，级别越高，log越详细

Enumerator
kNIMSDKLogLevelFatal	SDK Fatal级别Log
kNIMSDKLogLevelError	SDK Error级别Log
kNIMSDKLogLevelWarn	SDK Warn级别Log
kNIMSDKLogLevelApp	SDK应用级别Log，正式发布时为了精简sdk log，可采用此级别
kNIMSDKLogLevelPro	SDK调试过程级别Log，更加详细，更有利于开发调试
kNIMSDKLogLevelFatal	SDK Fatal级别Log.
kNIMSDKLogLevelError	SDK Error级别Log.
kNIMSDKLogLevelWarn	SDK Warn级别Log.
kNIMSDKLogLevelApp	SDK应用级别Log，正式发布时为了精简sdk log，可采用此级别
kNIMSDKLogLevelPro	SDK调试过程级别Log，更加详细，更有利于开发调试

Typedefs

Enumerations

Variables

Detailed Description

Typedef Documentation

◆ nim_global_detect_proxy_cb_func

◆ nim_global_sdk_db_error_cb_func

◆ nim_global_upload_sdk_log_cb_func

◆ nim_json_transport_cb_func

◆ nim_relogin_request_token_cb_func

◆ nim_sdk_del_cache_file_cb_func

◆ nim_sdk_exception_cb_func

◆ nim_sdk_feedback_cb_func

◆ nim_sdk_get_cache_file_info_cb_func

◆ nim_sdk_log_cb_func

Enumeration Type Documentation

◆ NIMDBOperation

◆ NIMProxyDetectStep

◆ NIMProxyType

◆ NIMSDKException

◆ NIMSDKLogLevel