NIM.ToolsAPI Class Reference

Public Member Functions
delegate void	Audio2TextDelegate (int rescode, string text, object userData)
	语音转文字结果委托 More...
delegate void	AntispamFilterDelegate (bool succeed, int code, string result)
	客户端反垃圾回调 More...

Static Public Member Functions
static string	GetUserAppDataDir (string appAccount)
	获取SDK里app account对应的app data目录（各个帐号拥有独立的目录，其父目录相同） More...
static string	GetUserSpecificAppDataDir (string appAccount, NIMAppDataType appdataType)
	获取SDK里app account对应的具体类型的app data目录（如图片消息文件存放目录，语音消息文件存放目录等） More...
static string	GetLocalAppDataDir ()
	获取本地存储路径 More...
static string	GetCurModuleDir ()
	获取安装目录（SDK DLL所在的当前目录） More...
static string	GetMd5 (string input)
	计算md5 More...
static string	GetFileMd5 (string filePath)
	计算文件的md5 More...
static string	GetUuid ()
	生成UUID More...
static void	GetAudioTextAsync (NIMAudioInfo audioInfo, string jsonExtension, NIMTools.GetAudioTextCb cb)
	语音转文字 More...
static void	ConverteAudio2Text (NIMAudioInfo audioInfo, Audio2TextDelegate cb, object userData=null)
	语音转文字 More...
static void	FilterClientAntispamAsync (string text, string replaceText, string libName, AntispamFilterDelegate cb)
	客户端反垃圾 More...

Member Function Documentation

AntispamFilterDelegate()

delegate void NIM.ToolsAPI.AntispamFilterDelegate	(	bool	succeed,
		int	code,
		string	result
	)

客户端反垃圾回调

Parameters

succeed	本地反垃圾成功
code	本地反垃圾状态，1-敏感词已被替换，替换后的内容可以发送 2：表明含有敏感词不允许发送 3：表明发送时需要将内容设置在消息结构的反垃圾字段里，由服务器过滤；
result	反垃圾处理后的内容

Audio2TextDelegate()

delegate void NIM.ToolsAPI.Audio2TextDelegate	(	int	rescode,
		string	text,
		object	userData
	)

语音转文字结果委托

Parameters

rescode	错误码
text	转换后的文字
userData	自定义数据

ConverteAudio2Text()

static void NIM.ToolsAPI.ConverteAudio2Text ( NIMAudioInfo  audioInfo, Audio2TextDelegate  cb, object  userData = null  )

static

语音转文字

Parameters

audioInfo	语音信息
cb	转换结果回调
userData	自定义数据，在回调函数中使用

FilterClientAntispamAsync()

static void NIM.ToolsAPI.FilterClientAntispamAsync ( string  text, string  replaceText, string  libName, AntispamFilterDelegate  cb  )

static

客户端反垃圾

Parameters

text	文本内容
replaceText	进行替换的字符串
libName	词库名称
cb	处理结果回调

GetAudioTextAsync()

static void NIM.ToolsAPI.GetAudioTextAsync ( NIMAudioInfo  audioInfo, string  jsonExtension, NIMTools.GetAudioTextCb  cb  )

static

语音转文字

Parameters

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

GetCurModuleDir()

static string NIM.ToolsAPI.GetCurModuleDir ( )

static

获取安装目录（SDK DLL所在的当前目录）

Returns

返回的目录路径

GetFileMd5()

static string NIM.ToolsAPI.GetFileMd5 ( string  filePath )

static

计算文件的md5

Parameters

filePath

文件完整路径

Returns

返回的md5

GetLocalAppDataDir()

static string NIM.ToolsAPI.GetLocalAppDataDir ( )

static

获取本地存储路径

Returns

返回的目录路径

GetMd5()

static string NIM.ToolsAPI.GetMd5 ( string  input )

static

计算md5

Parameters

input

需要计算md5的内容

Returns

返回的md5

GetUserAppDataDir()

static string NIM.ToolsAPI.GetUserAppDataDir ( string  appAccount )

static

获取SDK里app account对应的app data目录（各个帐号拥有独立的目录，其父目录相同）

Parameters

appAccount

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

Returns

返回的目录路径

GetUserSpecificAppDataDir()

static string NIM.ToolsAPI.GetUserSpecificAppDataDir ( string  appAccount, NIMAppDataType  appdataType  )

static

获取SDK里app account对应的具体类型的app data目录（如图片消息文件存放目录，语音消息文件存放目录等）

Parameters

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

Returns

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

GetUuid()

static string NIM.ToolsAPI.GetUuid ( )

static

生成UUID

Returns

返回的UUID