nim_tools_def.h File Reference

工具类 接口相关的常量函数等定义头文件 More...

#include "public_defines.h"

Go to the source code of this file.

Typedefs
typedef void(*	nim_tool_get_audio_text_cb_func) (int rescode, const char *text, const char *json_extension, const void *user_data)
typedef void(*	nim_tool_filter_client_antispam_cb_func) (bool succeed, int ret, const char *text, const char *json_extension, const void *user_data)
typedef void(*	nim_tool_sdk_log_cb_func) (const char *log_content, const void *user_data)
typedef void(*	nim_tool_sdk_collect_log_cb_func) (char **log_files, uint64_t *length, const void *user_data)
	SDK 日志上报时用户层指定的要上报的日志文件回调 More...

Enumerations
enum	NIMAppDataType { kNIMAppDataTypeUnknownOtherRes = 0 , kNIMAppDataTypeImage = 1 , kNIMAppDataTypeAudio = 2 , kNIMAppDataTypeVideo = 3 }

Variables
Trans Audio Msg Info Keys
static const char *	kNIMTransAudioKeyMime = "mime"
	string 语音类型
static const char *	kNIMTransAudioKeySample = "samp"
	string 语音采样率
static const char *	kNIMTransAudioKeyAudioUrl = "url"
	string 语音url
static const char *	kNIMTransAudioKeyDuration = "dur"
	long 语音时长，毫秒

Detailed Description

工具类 接口相关的常量函数等定义头文件

Copyright

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

Author

Harrison

Date

2015/2/1

Typedef Documentation

nim_tool_filter_client_antispam_cb_func

void(* nim_tool_filter_client_antispam_cb_func)(bool succeed, int ret, const char *text, const char *json_extension, const void *user_data)

nim callback function for client antispam

Parameters

[out]	succeed	本地反垃圾成功
[out]	ret	本地反垃圾结果码， 1：敏感词已被替换，替换后的内容可以发送，2：表明含有敏感词不允许发送；3：表明发送时需要将内容设置在消息结构的反垃圾字段里，由服务器过滤；
[out]	rescode	转换结果，成功200
[out]	text	反垃圾处理后的内容
[out]	json_extension	json扩展数据（备用）
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns

void 无返回值

nim_tool_get_audio_text_cb_func

void(* nim_tool_get_audio_text_cb_func)(const char *text, const char *json_extension, const void *user_data)

nim callback function for get audio text

Parameters

[out]	rescode	转换结果，成功200
[out]	text	语音文字
[out]	json_extension	json扩展数据（备用）
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

Returns

void 无返回值

nim_tool_sdk_collect_log_cb_func

void(* nim_tool_sdk_collect_log_cb_func)(const char *log_files, const void *user_data)

SDK 日志上报时用户层指定的要上报的日志文件回调

Parameters

[out]	log_files	日志文件列表，json array 格式，每个文件要求绝对路径
[out]	length	数据长度
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！

nim_tool_sdk_log_cb_func

void(* nim_tool_sdk_log_cb_func)(const char *log_content, const void *user_data)

SDK系统日志回调

Parameters

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

Returns

void 无返回值

Enumeration Type Documentation

NIMAppDataType

enum NIMAppDataType

AppData类型

Enumerator
kNIMAppDataTypeUnknownOtherRes	其他资源文件（除了消息历史文件和已知类型之外的消息数据缓存文件）
kNIMAppDataTypeImage	图片消息文件
kNIMAppDataTypeAudio	语音消息文件
kNIMAppDataTypeVideo	视频消息文件