Class Index | File Index

Classes


Class IYYSecurity


Extends IYYCommon.
安全接口。提供获取安全认证信息等功能。
Defined in: yyapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IYYSecurity 构造函数。
Method Summary
Method Attributes Method Name and Description
 
获取当前用户安全认证令牌。
 
敏感词检查。检查字符串中是否包含敏感词。
 
进行举报。当发现需要举报内容时,调用此Api会弹出举报窗口。
 
截屏进行举报。当发现需要举报内容时,调用此Api会弹出举报窗口。
Methods borrowed from class IYYCommon:
addEventListener, removeEventListener
Class Detail
IYYSecurity()
IYYSecurity 构造函数。
Method Detail
{Object} getToken()
获取当前用户安全认证令牌。
使用示例:
var result = yy.security.getToken();
if (result.ret == 0) {
  document.getElementById("txtLog").innerHTML = "token="+result.token;
}
else
{
  document.getElementById("txtLog").innerHTML ="无法得到Token,错误码ret="+result.ret;
}
成功的返回值示例:{ ret:0,token:"b9b8b4e4d0e107b3c7bd74bc48a6e28f0b1a0d61"}
失败的返回值示例:{ ret:984832}
Returns:
返回令牌字符信息,是一个Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
token: Number类型 令牌字符

{Object} keywordFilter(words)
敏感词检查。检查字符串中是否包含敏感词。
使用示例:
var result = yy.security.keywordFilter("Hello");
if (result.ret == 0) {
  document.getElementById("txtLog").innerHTML = result.pass?"不包含敏感词":"含有敏感词";
}
else
{
  document.getElementById("txtLog").innerHTML ="无法检查,错误码ret="+result.ret;
}
成功的返回值示例:{ ret:0,pass:true}
失败的返回值示例:{ ret:984832}
Parameters:
{String} words
等待检查的字符串。
Returns:
返回是否包含敏感词,是一个Object对象,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。
pass: Boolean类型 true=检查通过,不包含敏感词,false=包含敏感词

{Object} reportAbuse()
进行举报。当发现需要举报内容时,调用此Api会弹出举报窗口。
Returns:
返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

{Object} reportScreenshot()
截屏进行举报。当发现需要举报内容时,调用此Api会弹出举报窗口。
Returns:
返回调用是否成功,具体属性如下。
ret: Number类型 返回码 0=成功,非0值失败,具体请参考错误代码。

Documentation generated by JsDoc Toolkit 2.4.0