nim_tools.h File Reference

工具类，提供了包括获取用户/应用目录，计算MD5，计算UUID，语音转文字等功能等 More...

#include "nim_tools_def.h"

Go to the source code of this file.

Functions
NIM_SDK_DLL_API const char *	nim_tool_get_user_appdata_dir (const char *app_account)
NIM_SDK_DLL_API const char *	nim_tool_get_user_specific_appdata_dir (const char *app_account, enum NIMAppDataType appdata_type)
NIM_SDK_DLL_API const char *	nim_tool_get_local_appdata_dir ()
NIM_SDK_DLL_API const char *	nim_tool_get_cur_module_dir ()
NIM_SDK_DLL_API const char *	nim_tool_get_md5 (const char *input)
NIM_SDK_DLL_API const char *	nim_tool_get_file_md5 (const char *file_path)
NIM_SDK_DLL_API const char *	nim_tool_get_uuid ()
NIM_SDK_DLL_API void	nim_tool_get_audio_text_async (const char *json_audio_info, const char *json_extension, nim_tool_get_audio_text_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_tool_filter_client_antispam_async (const char *text, const char *replace_str, const char *lib_name, const char *json_extension, nim_tool_filter_client_antispam_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_tool_reg_sdk_log_callback (nim_tool_sdk_log_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_tool_reg_collect_log_callback (nim_tool_sdk_collect_log_cb_func cb, const void *user_data)
	SDK 在进行日志反馈时应用层需要添加的日志文件回调 More...

Detailed Description

工具类，提供了包括获取用户/应用目录，计算MD5，计算UUID，语音转文字等功能等

Copyright

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

Author

Harrison

Date

2015/2/1

Function Documentation

nim_tool_filter_client_antispam_async()

void nim_tool_filter_client_antispam_async	(	const char *	text,
		const char *	replace_str,
		const char *	lib_name,
		const char *	json_extension,
		nim_tool_filter_client_antispam_cb_func	cb,
		const void *	user_data
	)

客户端反垃圾

Parameters

[in]	text	文本内容，UTF-8
[in]	replace_str	进行替换的字符串，UTF-8
[in]	lib_name	词库名称，UTF-8
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_tool_get_audio_text_async()

void nim_tool_get_audio_text_async	(	const char *	json_audio_info,
		const char *	json_extension,
		nim_tool_get_audio_text_cb_func	cb,
		const void *	user_data
	)

语音转文字

Parameters

[in]	json_audio_info	语音信息
[in]	json_extension	json扩展参数（备用，目前不需要）
[in]	cb	语音转文字回调
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

Note

错误码 200:成功 403:没有权限 414:参数错误 500:未知错误 6101:语音转码解析失败 6102:语音时长过长（超过60s 6103:服务不可用 6104:audioUrl不合法

nim_tool_get_cur_module_dir()

const char * nim_tool_get_cur_module_dir

(

)

获取安装目录（SDK DLL所在的当前目录），需要调用nim_free_buf(void *data)释放内存

Returns

const char * 返回的目录路径

nim_tool_get_file_md5()

const char * nim_tool_get_file_md5

(

const char *

file_path

)

计算文件的 MD5，需要调用nim_free_buf(void *data)释放内存

Parameters

[in]

file_path

文件完整路径，UTF-8

Returns

const char * 返回的md5

nim_tool_get_local_appdata_dir()

const char * nim_tool_get_local_appdata_dir

(

)

获取本地存储路径，需要调用nim_free_buf(void *data)释放内存

Returns

const char * 返回的目录路径

nim_tool_get_md5()

const char * nim_tool_get_md5

(

const char *

input

)

计算 MD5，需要调用nim_free_buf(void *data)释放内存

Parameters

[in]

input

需要计算md5的内容

Returns

const char * 返回的md5

nim_tool_get_user_appdata_dir()

const char * nim_tool_get_user_appdata_dir

(

const char *

app_account

)

获取SDK里app account对应的app data目录（各个帐号拥有独立的目录，其父目录相同），需要调用nim_free_buf(void *data)释放内存

Parameters

[in]

app_account

APP account。如果传入空字符串，则将获取到各个帐号目录的父目录（谨慎删除！）

Returns

const char * 返回的目录路径

nim_tool_get_user_specific_appdata_dir()

const char * nim_tool_get_user_specific_appdata_dir	(	const char *	app_account,
		enum NIMAppDataType	appdata_type
	)

获取SDK里app account对应的具体类型的app data目录（如图片消息文件存放目录，语音消息文件存放目录等），需要调用nim_free_buf(void *data)释放内存

Parameters

[in]	app_account	APP account。如果传入空字符串，则返回结果为空
[in]	appdata_type	具体类型的app data。见NIMAppDataType定义

Returns

const char * 返回的目录路径（目录可能未生成，需要app自行判断是否已生成）

nim_tool_get_uuid()

const char * nim_tool_get_uuid

(

)

生成UUID，需要调用nim_free_buf(void *data)释放内存

Returns

const char * 返回的UUID

nim_tool_reg_collect_log_callback()

void nim_tool_reg_collect_log_callback	(	nim_tool_sdk_collect_log_cb_func	cb,
		const void *	user_data
	)

SDK 在进行日志反馈时应用层需要添加的日志文件回调

Parameters

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

Returns

void 无返回值