Class YidunService

Unregister all the callbacks registered by registInfoReceiver.

取消registInfoReceiver注册过的所有回调

netease.yidun.yidunService.clearInfoReceivers();

Account logout, only supported on iOS, will be ignored if called on non-iOS.

账号退出登录，仅支持iOS，在非iOS系统下调用会被忽略

NOTE: In order to switch account, you can call setRoleInfo for different account directly, the original account will automatically logout, you don't need to call this interface.

注：您可以直接调用setRoleInfo来切换账号，会自动退出之前的账号，不需要调用该接口

netease.yidun.yidunService.devastatedMovement();

Get the verification result of the data, you need to send the result to game server for verification.

获取指定数据的校验结果，您需要发送校验结果到游戏服务端，由游戏服务端进行校验

Get an unique token from the anti-cheat module, the client need to send this token to the backend, then the backend use the token to request 'check' interface to get the detection result. For the detail about backend, please contact Yidun.

向反作弊模块获取唯一凭证token，业务方客户端需要将此token提交到业务后端，业务后端再使用此token来请求check接口获取检测结果，后端相关接入请联系易盾

const token = await netease.yidun.yidunService.getToken();

Initialize the anti-cheat, enable the anti-cheat service, need to be called after the game starts.

初始化反外挂，开启反外挂服务，需要在游戏启动后调用

netease.yidun.yidunService.init();
netease.yidun.yidunService.init(netease.yidun.ServerType.Other);
netease.yidun.yidunService.init(netease.yidun.ServerType.ChineseMainland, 'https://www.netease163.com');

General query, query information for root, simulator, anti-cheat and other functionalities. Only supported on Android, for iOS, please use ioctlIos instead, calling this interface on non-Android will return string 'Only supported on Android'.

通用查询，查询root、模拟器、反外挂等信息以及其他定制功能。仅支持Android，iOS请使用ioctlIos，在非Android系统下调用该接口会返回字符串'Only supported on Android'

netease.yidun.yidunService.ioctlAndroid(netease.yidun.RequestCmdIdAndroid.GetEmulatorName, '');

General query, query information for jailbreak, sign, sdk version and other functionalities. Only supported on iOS, for Android, please use ioctlAndroid instead, calling this interface on non-iOS will return string 'Only supported on iOS'.

通用查询，查询越狱、签名、SDK版本号等信息以及其他定制功能。仅支持iOS，Android请使用ioctlAndroid，在非iOS系统下调用该接口会返回字符串'Only supported on iOS'

netease.yidun.yidunService.ioctlIos(netease.yidun.RequestCmdIdIos.QueryRootStatus, '');

Decode the data encoded by localSaveBytesEncode. Only supported on Android, calling this interface on non-Android will return an empty Uint8Array.

解密localSaveBytesEncode加密过的数据。仅支持Android系统，在非Android系统下调用该接口会返回空的Uint8Array

const inputBytes = new Uint8Array([0, 255, 128, 4]);
const encodedData = netease.yidun.yidunService.localSaveBytesEncode(inputBytes, 0);
const decodedBytes = netease.yidun.yidunService.localSaveBytesDecode(encodedData, 0);

Provide encoding functionality for the data (in byte array form) that need to save locally. Only supported on Android, calling this interface on non-Android will return string 'Only supported on Android'.

为需要本地存储的数据（为字节数组形式）提供加密功能。仅支持Android系统，在非Android系统下调用该接口会返回字符串'Only supported on Android'

const inputBytes = new Uint8Array([0, 255, 128, 4]);
const encodedData = netease.yidun.yidunService.localSaveBytesEncode(inputBytes, 0);

Decode the data encoded by localSaveEncode. Only supported on Android, calling this interface on non-Android will return string 'Only supported on Android'.

解密localSaveEncode加密过的数据。仅支持Android系统，在非Android系统下调用该接口会返回字符串'Only supported on Android'

const inputData = 'Test text';
const encodedData = netease.yidun.yidunService.localSaveEncode(inputData, 0);
const decodedData = netease.yidun.yidunService.localSaveDecode(encodedData, 0);

Provide encoding functionality for the data (in string form) that need to save locally. Only supported on Android, calling this interface on non-Android will return string 'Only supported on Android'.

为需要本地存储的数据（为字符串形式）提供加密功能。仅支持Android系统，在非Android系统下调用该接口会返回字符串'Only supported on Android'

const inputData = 'Test text';
const encodedData = netease.yidun.yidunService.localSaveEncode(inputData, 0);

Get token to obtain cheating monitoring result in real time, only supported on iOS, will resolve an error result (code: 500) if called on non-iOS, please see the documentation of MemorizerAlarmSpeedometerResult for detail about return value.

获取token，用于实时获取作弊监控结果，仅支持iOS，在非iOS系统下调用会返回一个错误结果（code: 500），关于返回值的详细请查看MemorizerAlarmSpeedometerResult的文档

const result = await netease.yidun.yidunService.memorizerAlarmSpeedometer();
cc.log(result.code);
if (result.code === 200) cc.log(result.token);

Set transparent transmission type, only supported on iOS, will be ignored if called on non-iOS. if you don't use transparent transmission, you don't need to call this interface. NOTE: in order to use transparent transmission, you need to pass url of your transparent transmission server when calling the init.

设置透传的类型，仅支持iOS，非iOS系统下调用会被忽略。不使用透传，您不需要调用该接口。注：使用透传需要在调用init时通过url参数传递透传服务器地址

netease.yidun.yidunService.readyForOpportunity(netease.yidun.TransparentTransmissionType.ForceTransparentTransmission);

Register a callback to receive heart beat information.

注册回调以接收心跳信息

netease.yidun.yidunService.registInfoReceiver((type, info) => {
  if (type === netease.yidun.NetHeartBeatInfoType.HeartBeat) {
    // This heart beat type will only triggered on Android.
    // 该类型的心跳信息仅会在Android下触发。
    cc.log('Receive heart beat:', info);
  } else if (type === netease.yidun.NetHeartBeatInfoType.EncHeartBeat) {
    cc.log('Receive heart beat in encrypted form:', info);
    cc.log('You need sending it to server for decryption');
  } else if (type === netease.yidun.NetHeartBeatInfoType.CheatInfo) {
    // This heart beat type will only triggered on Android.
    // 该类型的心跳信息仅会在Android下触发。
    cc.log('Receive cheat info:', info);
  }
});

Start collecting click events related data to detect click simulation. Only supported on Android, will be ignored if called on non-Android.

开始采集点击事件相关数据以检测模拟点击。仅支持Android，在非Android系统下调用会被忽略

NOTE: This function need separate payment, only use this function if you have strong demand for detecting click simulation cheating.

注：该功能是单独付费功能，非强烈需要挖掘模拟点击类外挂的游戏，不需要接入

netease.yidun.yidunService.registerTouchEvent(123, 456);

The encrypt/decrypt interface of secure communication protocol, only supported on Android, will be ignored if called on non-Android.

安全通信协议的加密解密接口，仅支持Android，在非Android系统下调用会被忽略。

netease.yidun.yidunService.safeComm('test', 0, false);
netease.yidun.yidunService.safeComm(encryptedData, 0, true);

Set the information of the logged-in user. After setting, the character ID and other information will be associated with the anti-cheat data and device information during data processing, which can obtain the malicious player's cheat information in real time, and the game can use the corresponding data to accurately punish the malicious player.

设置登录用户的信息，设置后，数据处理时会将角色ID等信息与反外挂数据、设备信息关联，能实时获取恶意玩家使用外挂情况，游戏可通过相应数据对恶意玩家进行精准打击

NOTE: Regarding the data forwarding domain name/IP/port (see the gameJson parameter), after setting, when fail to send the data to the Yidun server, it will continue to send the data to the game server. For domain name and IP, you can choose to set one of them or both of them, the port is defaulted to 80. Before setting these fields, you need to contact with Yidun technicians. Try to pass these fields at the beginning, and set up server forwarding later. Data forwarding will only be performed after the failure to send to the Yidun server.

注：关于数据转发域名/IP/端口（见gameJson参数），设置之后，当数据发送到易盾后端失败后，会继续向游戏服务端发送数据，由游戏方服务端转发到易盾后端.域名和IP可以选择设置一个或者都设置，端口默认使用80。在设置这些字段前需要和易盾技术人员确定。尽量默认接入的时候带上，之后有需要再搭建服务端转发，数据转发只会在发送到易盾服务端失败后才会进行

const roleId = '123456';
const roleName = '易小盾';
const roleAccount = 'yd@163.com';
const roleServer = '游戏测试服';
const gameJson = {
  GameVersion: '1.0.1',
  AssetVersion: '1.0.1',
  TransHost: 'test.163.com',
  TransIP: '8.8.8.8',
  TransPort: 80,
};
netease.yidun.yidunService.setRoleInfo(
  roleId,
  roleName,
  roleAccount,
  roleServer,
  JSON.stringify(gameJson)
);
// gameJson.GameVersion En: Game version. Zh: 游戏版本
// gameJson.AssetVersion En: Assets version. Zh: 资源文件版本
// gameJson.TransHost En: The domain name to forward anti-cheat data when the Yidun server is unreachable. Zh: 当易盾网络不通时，反外挂数据转发域名地址
// gameJson.TransIP En: The IP to forward anti-cheat data when the Yidun server is unreachable. Zh: 当易盾网络不通时，反外挂数据转发IP
// gameJson.TransPort En: The port to forward anti-cheat data when the Yidun server is unreachable. Zh: 当易盾网络不通时，反外挂数据转发端口

Reporting system, only supported on iOS, will be ignored if called on non-iOS. Used in the scenario: player A found that player B may cheating, player A then use the reporting system to report this information.

举报系统，仅支持iOS，在非iOS系统下调用会被忽略。用于玩家A发现玩家B存在使用外挂嫌疑，玩家A通过举报系统举报玩家B。

const roleId = '123456';
const roleName = '易小盾';
const roleAccount = 'yd@163.com';
const roleServer = '游戏测试服';
const reportDesc = '自瞄';
const verificationSpan = 1;
const reportType = netease.yidun.ReportType.Plug;
netease.yidun.yidunService.successOpportunityComes(
  roleId,
  roleName,
  roleAccount,
  roleServer,
  reportDesc,
  verificationSpan,
  reportType
);

Unregister the callback registered by registInfoReceiver.

取消registInfoReceiver注册过的回调

const infoReceiver = (type, info) => {
  if (type === netease.yidun.NetHeartBeatInfoType.HeartBeat) {
    // This heart beat type will only triggered on Android.
    // 该类型的心跳信息仅会在Android下触发。
    cc.log('Receive heart beat:', info);
  } else if (type === netease.yidun.NetHeartBeatInfoType.EncHeartBeat) {
    cc.log('Receive heart beat in encrypted form:', info);
    cc.log('You need sending it to server for decryption');
  } else if (type === netease.yidun.NetHeartBeatInfoType.CheatInfo) {
    // This heart beat type will only triggered on Android.
    // 该类型的心跳信息仅会在Android下触发。
    cc.log('Receive cheat info:', info);
  }
};
netease.yidun.yidunService.registInfoReceiver(infoReceiver);
netease.yidun.yidunService.unregistInfoReceiver(infoReceiver);

Stop collecting click events related data. Only supported on Android, will be ignored if called on non-Android.

停止采集点击事件相关数据。仅支持Android，在非Android系统下调用会被忽略

netease.yidun.yidunService.unregisterTouchEvent();

Manually transparent transmission, only supported on iOS, will return an empty Uint8Array if called on non-iOS. You can get the data and combine the data with other encrypted data, then send the data to the game server and let the game server transmit the data to Yidun server.

自助式透传，仅支持iOS，在非iOS系统下调用会返回空的Uint8Array。游戏⽅⾃⾏选择获取数据的时机。建议将数据合并到其他加密数据中，发送到游戏服务器，通过请求发送到易盾服务器