NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
类型定义 | 枚举
nim_global_def.h 文件参考

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

#include "public_defines.h"

浏览源代码.

类型定义

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_request_login_extension_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)
 上传SDK日志回调
 
typedef void(* nim_global_upload_sdk_log_async_cb_func) (int rescode, const char *download_url, 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)
 

枚举

enum  NIMSDKLogLevel {
  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
}
 

变量

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"
 具体的出错信息
 

详细描述

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

版权所有
(c) 2015-2017, NetEase Inc. All rights reserved
作者
Harrison
日期
2015/2/1

类型定义说明

◆ 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)

探测代理回调

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

◆ nim_global_sdk_db_error_cb_func

void(* nim_global_sdk_db_error_cb_func)(const char *error_info)

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

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

◆ nim_global_upload_sdk_log_async_cb_func

typedef void(* nim_global_upload_sdk_log_async_cb_func) (int rescode, const char *download_url, const void *user_data)

◆ nim_global_upload_sdk_log_cb_func

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

上传SDK日志回调

上传SDK日志回调

参数
[out]rescode
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值
参数
[out]rescode错误码
[out]download_url下载地址
[out]user_dataAPP 的自定义用户数据，SDK 只负责传回给回调函数，不做任何处理！
返回
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

参数
[out]json_params输出的json字符串内容
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
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)

登录时请求新的鉴权回调

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

◆ nim_request_login_extension_cb_func

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

登录时请求第三方鉴权扩展信息回调

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

◆ nim_sdk_del_cache_file_cb_func

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

删除sdk缓存文件回调

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

◆ nim_sdk_exception_cb_func

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

输出当前环境异常回调

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

◆ nim_sdk_feedback_cb_func

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

SDK反馈回调

参数
[out]rescode错误码
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
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缓存文件信息回调

参数
[out]info信息
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_sdk_log_cb_func

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

输出sdk log回调

参数
[out]log_levellog级别，见NIMSDKLogLevel
[out]loglog内容
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

枚举类型说明

◆ NIMDBOperation

enum NIMDBOperation

对DB进行的操作类型

枚举值
kNIMDBOperationInsert 

写操作

kNIMDBOperationRead 

读操作

kNIMDBOperationUpdate 

更新操作

kNIMDBOperationDelete 

删除操作

◆ NIMProxyDetectStep

enum NIMProxyDetectStep

代理测试步骤

枚举值
kNIMProxyDetectStepAllComplete 

探测代理有效性结束

◆ NIMProxyType

enum NIMProxyType

代理类型

枚举值
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

异常

枚举值
kNIMSDKExceptionSpaceEmpty 

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

◆ NIMSDKLogLevel

enum NIMSDKLogLevel

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

枚举值
kNIMSDKLogLevelFatal 

SDK Fatal级别Log

kNIMSDKLogLevelError 

SDK Error级别Log

kNIMSDKLogLevelWarn 

SDK Warn级别Log

kNIMSDKLogLevelApp 

SDK应用级别Log，正式发布时为了精简sdk log，可采用此级别

kNIMSDKLogLevelPro 

SDK调试过程级别Log，更加详细，更有利于开发调试

变量说明

◆ kNIMCacheFileAudio

const char* kNIMCacheFileAudio = "audio"
static

语音消息缓存

◆ kNIMCacheFileCount

const char* kNIMCacheFileCount = "file_count"
static

int,文件数量

◆ kNIMCacheFileImage

const char* kNIMCacheFileImage = "image"
static

图片消息缓存

◆ kNIMCacheFileOther

const char* kNIMCacheFileOther = "res"
static

杂项文件缓存

◆ kNIMCacheFilePath

const char* kNIMCacheFilePath = "file_path"
static

string,文件所在文件夹路径

◆ kNIMCacheFileTotalSize

const char* kNIMCacheFileTotalSize = "total_size"
static

int64,文件总大小KB

◆ kNIMCacheFileType

const char* kNIMCacheFileType = "file_type"
static

string,文件类型

◆ kNIMCacheFileVideo

const char* kNIMCacheFileVideo = "video"
static

视频消息缓存

◆ kNIMDBErrAttach

const char* kNIMDBErrAttach = "error_attach"
static

具体的出错信息

◆ kNIMDBErrCode

const char* kNIMDBErrCode = "error_code"
static

错误码

◆ kNIMDBErrDBName

const char* kNIMDBErrDBName = "db_name"
static

出错DB的名称

◆ kNIMDBErrDescription_

const char* kNIMDBErrDescription_ = "error_description"
static

相应的错误描述

◆ kNIMDBERROperation

const char* kNIMDBERROperation = "operation"
static

出错DB的操作(读、写、更新、删除)

◆ kNIMGrayMixStoreEnable

const char* kNIMGrayMixStoreEnable = "mixStoreEnable"
static

bool, 是否开启融合存储

◆ kNIMGrayTestEnable

const char* kNIMGrayTestEnable = "testEnbale"
static

bool, 是否开启测试

◆ kNIMResCode

const char* kNIMResCode = "err_code"
static

int, NIMResCode