SDK对接文档

主题

基础常规接口 ​

GameHelper.AppUtil

GameHelper.App

隐私政策 ​

TypeScript
// 跳转到隐私界面
public gotoPrivacyPolicyStatic() {}

用户协议 ​

TypeScript
// 跳转到用户协议
public gotoTermsServiceStatic() {}

欧盟隐私 ​

  • 非欧盟地区，不弹 GDPR，设置界面没有 GDPR 按钮
  • 欧盟地区，弹 GDPR，设置界面出现 GDPR 按钮，点击弹出 GDPR 界面
TypeScript
//监听 是否为欧盟地区 如果true 可以展示欧盟弹窗
public inEeaForGDPRListen(callback : (inEea : boolean) => void) {}
// 移除 监听
public inEeaForGDPRRemove() {}


//state: 0-欧盟弹窗关闭 1-欧盟弹窗展示 （注，如果回调了1，那么后续会有0）
public showGDPRDialogStatic(callback :(status : number) => void) {}

用户评价 ​

TypeScript
//跳转系统评价
public goEvaluate() {}

反馈功能 ​

TypeScript
//跳转到反馈页面
public showFeedback() {}

分享 ​

TypeScript
// 分享 文字 如果想分享appstore地址 可以将地址填入 content
public shareApp(opt: {
    title: string,
    content: string,
    imagePath?: string, // 图片本地地址 不能是网络地址 而且绝对路径（选填）
    success? : (params) => void}) {}

分享图片 ​

TypeScript
//分享照片 iOS可以分享网络图片 安卓暂不支持分享网络图片 如果要分享 请先自行下载本地再分享
//title content这两个参数没什么用
//imageUrl是绝对路径
//如果资源是在游戏工程的resource目录下 可以使用GameHelper.FileUtils.rawUrl 获取绝对路径
public shareImage(obj : {title? : string, content? : string, imageUrl : string, success? : (type) => void, fail? : () => void}){}

获取在线参数 ​

TypeScript
//获取在线参数 param传入key
public getOnlineConfigParams(param : string) : string {}

云存储 ​

将数据上传至服务器 （用的是设备做唯一标识）

TypeScript
//上传数据到云 唯一标识是deviceId
//code-0失败 1-成功
public uploadCloudArchive(key : string , value : string, callback : (code : number, key : string, msg : string) => void) {}

云下载 ​

TypeScript
//code说明：（0：失败 1：成功  -6:存档不存在；-10：拉取数据为空；-9999：服务器异常报错）
// 其他errorCode可统一失败处理
public pullCloudArchive(key : string, callback : (code : number, value : string, msg : string) => void) {}

检查敏感词 ​

TypeScript
/**
     * 游戏调用 url 三方检测敏感词吗，返回完整的接口响应response，网络错误或其他失败情况将返回“{}”
     * @param type      1文本  2图片
     * @param checkInfo 具体信息（文本类型为字符串、如果是图片类型为http的url）
     * @param scene     场景类型 默认传空字符串即可
     * levelFlag 为true 表示当前没有敏感词  false当前有敏感词 目前没有返回敏感词的参数
     * fail 表示当前网络请求失败
    * */
    public checkThirdSensitiveInfoStatic(type : number,
        checkInfo : string,
        scene : string = "", success : (levelFlag : boolean) => void, fail : (error : string) => void) {}

适龄提示相关 ​

getUnderAgeLimitLevelStatic 判断显示适龄提示的年龄，返回 0 不现实适龄按钮 showEligibleAgeAlertStatic 点击跳转

是否显示适龄提示 ​

TypeScript
/**
 * 是否显示适龄提示入口。 0不显示
 * @return 0 8 12 16
 */
public getUnderAgeLimitLevelStatic() : number {

显示适龄提示 ​

TypeScript
// 弹出适龄弹窗
public showEligibleAgeAlertStatic() {}

获取服务器时间戳 当前时区 ​

TypeScript
/**
 * 从服务器时区获取真实时间
 * @return 获取失败返回为：0
 * 获取成功返回当前时区的时间戳，单位为毫秒。
 */
public getServerTimeByServerTimeZoneStatic() : number {}

普通时间戳（0 时区为基准） ​

TypeScript
//普通时间戳（0时区为基准）
public serverTimeStampWithoutTimeZone() : number {}

获取所有的渠道信息 ​

TypeScript
/**
 * 获取所有的渠道信息
 * 举例渠道为google9-cn的情况
 * {
 * "chnlAzb":"9", Ad的az测试id 0或者9
 * "chnl2Flag":"", 这里是二级渠道，不用关注
 * "chnlAb":"-1", 游戏ab测试id，-1,1~8
 * "chnlFlag":"google", 原始渠道
 * "chnlCountry":"cn" 渠道所属国家
 * }
 * @return
 */
public getChannelInfoStatic() : string {}

展示退出弹框（退出应用时弹框提示） ​

TypeScript
/**
 * 展示退出弹框
 */
public showExitDialog() {}

获取系统语言数值类型 ​

TypeScript
/** 说明
语言代码编号 -  语言描述
0 - 英文
1 - 中文简体
2 - 中文繁体
3 - 法语
4 - 意大利语
5 - 德语
6 - 西班牙语
7 - 西班牙语(墨西哥)
8 - 荷兰语
9 - 俄语
10 - 韩语
11 - 日语
12 - 匈牙利语
13 - 葡萄牙语
14 - 阿拉伯语
15 - 挪威语
16 - 波兰语
17 - 土耳其语
18 - 乌克兰语
19 - 罗马尼亚语
20 - 保加利亚语
21 - 印地语
22 - 印度尼西亚语
23 - 越南语
24 - 孟加拉语
25 - 马来西亚语
26 - 泰语
27 - 瑞典语
28 - 芬兰语
29 - 捷克语
30 - 希腊语
31 - 丹麦语
32 - 阿塞拜疆语
**/
public GetSystemLanguage() : number {}

直接获取本地语言，zh 等 ​

TypeScript
/**
 * 直接获取设备语言接口，zh等。
 */
public getLocaleOnlyLanguage() : string {}

获取用户归因状态 ​

TypeScript
/**
 * 获取用户归因状态，是买量用户还是自然用户
 * AppsFlyer接口判断自然用户和买量用户不够准确，对方接口有超时机制，会导致部分买量用户被判断成自然用户。酌情使用
 * @return -1还没拿到结果,3s后重查   0自然用户   1买量用户  2没有af功能不需要重试
 */
public getOrganicInstallStatic() : number {}

获取当前渠道 ​

TypeScript
public getAppChannel() : string {}

获取渠道 id ​

TypeScript
//单渠道为-1 A包为0，b包为1，c包为2
public getAppChannelId() : number {}

获取当前版本名 ​

TypeScript
/**
 * 获取当前版本名
 */
public getVersionName() : string {}

获取当前版本号 ​

TypeScript
/**
* 获取当前版本号
*/
public getVersionCode() : number {}

获取包名 ​

TypeScript
//获取包名
public getPackageName() : string {}

获取安装版本号 ​

TypeScript
/**
* 获取安装版本号
*/
public getInstallVersion() : string {}

bugly自定义日志上报 ​

typescript
// 自定义bugly日志上报（iOS支持，Android目前空实现）
public postBuglyInfo(msg : string => void) {}

谷歌资源分包下载 ​

TypeScript
//下载谷歌分包资源
//downloadSize totalSize 单位字节
public downloadGoogleModuleAsset(opts : {
    moduleName : string, 
    success : (path : string, moduleName : string) => void, 
    fail : (error: string, moduleName : string) => void,
    progress? : (totalSize : number, downloadSize : number) => void
})

//获取指定模块资源的路径，没有返回空
public getGoogleModuleAssetPath(moduleName : string) : string

启动实名认证结果监听 ​

TypeScript
//监听游戏启动时，平台弹出的实名认证
//实名完成，有实名的功能才会有这个回调，一般国内发布会有实名
//result 0未认证 1已认证
public onCertification(callback : (result : number) => void) : string;
public offCertification(uuid : string);
点我快速对接