NIM SDK提供的一些工具接口，主要包括获取SDK里app account对应的app data目录，计算md5等
More...
#include <nim_cpp_tool.h>
|
|
typedef std::function< void(int rescode, const std::string &text)> | GetAudioTextCallback |
| | 语音转文字回调模板
|
| |
|
typedef std::function< void(bool succeed, int ret, const std::string &text)> | FilterClientAntispamCallback |
| | 客户端反垃圾回调模板
|
| |
|
typedef std::function< void(const std::string &text)> | SDKLogCallback |
| | SDK系统日志回调模板
|
| |
|
typedef std::function< void(std::list< std::string > &logs)> | CollectLogCallback |
| | 用户注册的收集日志的回调模板
|
| |
NIM SDK提供的一些工具接口，主要包括获取SDK里app account对应的app data目录，计算md5等
◆ FilterClientAntispam()
| static void nim::Tool::FilterClientAntispam |
( |
const std::string & |
text, |
|
|
const std::string & |
replace_str, |
|
|
const std::string & |
lib_name, |
|
|
const FilterClientAntispamCallback & |
callback |
|
) |
| |
|
static |
客户端本地反垃圾
- Parameters
-
| [in] | text | 文本内容，UTF-8 |
| [in] | replace_str | 进行替换的字符串，UTF-8 |
| [in] | lib_name | 词库名称，UTF-8 |
| [in] | callback | 回调函数 |
- Returns
- Note
- 回调函数ret 1：敏感词已被替换；2：含有敏感词不允许发送；3：需要将内容设置在消息结构的反垃圾字段里，由服务器过滤
◆ GetAudioTextAsync()
语音转文字
- Parameters
-
| [in] | audio_info | 语音信息 |
| [in] | cb | 语音转文字回调 |
| [in] | json_extension | json扩展参数（备用，目前不需要） |
- Returns
- bool 检查参数如果不符合要求则返回失败
- Note
- 错误码 200:成功 403:没有权限 414:参数错误 500:未知错误 6101:语音转码解析失败 6102:语音时长过长（超过60s 6103:服务不可用 6104:audioUrl不合法
◆ GetCurModuleDir()
| std::string nim::Tool::GetCurModuleDir |
( |
| ) |
|
|
static |
获取安装目录（SDK DLL所在的当前目录）
- Returns
- std::string 返回的目录路径(UTF8)
◆ GetFileMd5()
| std::string nim::Tool::GetFileMd5 |
( |
const std::string & |
file_path | ) |
|
|
static |
计算文件的md5
- Parameters
-
| [in] | file_path | 文件完整路径，UTF-8 |
- Returns
- std::string 返回的md5
◆ GetLocalAppdataDir()
| std::string nim::Tool::GetLocalAppdataDir |
( |
| ) |
|
|
static |
获取本地存储路径
- Returns
- std::string 返回的目录路径(UTF8)
◆ GetMd5()
| std::string nim::Tool::GetMd5 |
( |
const std::string & |
input | ) |
|
|
static |
计算md5
- Parameters
-
- Returns
- std::string 返回的md5
◆ GetSpecificAppdataDir()
| static std::string nim::Tool::GetSpecificAppdataDir |
( |
const std::string |
app_account, |
|
|
enum NIMAppDataType |
appdata_type |
|
) |
| |
|
static |
获取SDK里app account对应的具体类型的app data目录（如图片消息文件存放目录，语音消息文件存放目录等），需要调用nim_free_buf(void *data)释放内存
- Parameters
-
| [in] | app_account | APP account。如果传入空字符串，则返回结果为空 |
| [in] | appdata_type | 具体类型的app data。见NIMAppDataType定义 |
- Returns
- std::string返回的目录路径（目录可能未生成，需要app自行判断是否已生成）
◆ GetUserAppdataDir()
| std::string nim::Tool::GetUserAppdataDir |
( |
const std::string & |
app_account | ) |
|
|
static |
获取SDK里app account对应的app data目录（各个帐号拥有独立的目录，其父目录相同）
- Parameters
-
| [in] | app_account | APP account。如果传入空字符串，则将获取到各个帐号目录的父目录（谨慎删除！） |
- Returns
- std::string 返回的目录路径(UTF8)
◆ GetUuid()
| std::string nim::Tool::GetUuid |
( |
| ) |
|
|
static |
生成UUID
- Returns
- std::string 返回的UUID
◆ RegCollectLogCallback()
注册自定义日志收集文件的回调
- Parameters
-
◆ RegSDKLogCallback()
| static void nim::Tool::RegSDKLogCallback |
( |
const SDKLogCallback & |
callback | ) |
|
|
static |
SDK系统日志回调，可用于动态获取日志，不建议用于生产环境
- Parameters
-
- Returns
The documentation for this class was generated from the following files:
1.9.4