# Gamelet PixUI Uniform Frame

### GameletAPI 使用指引

+ 手动引入

```
yarn add gamelet-pixui-frame
```

+ 在preprocess页面的代码中引用接口

```
import { GameletAPI } from "gamelet-pixui-frame"
```
直接使用GameletAPI即可,GameletAPI是前置虚拟机页面使用的API


+ 在app和popup页面的代码中引用接口
```
import { AppGameletAPI } from 'gamelet-pixui-frame/js_src/ts_src/framework/gameletapi';
```
可以将 AppGameletAPI as GameletAPI,然后在活动页面使用AppGameletAPI


+ 注意
GameletAPI 和 AppGameletAPI 是两个接口.GameletAPI是前置虚拟机页面使用的接口而AppGameletAPI是活动页面使用的接口


### 变更历史
0.4.13-beta.13
+ 添加了getAppId方法在app和preprocess中，保持与裁剪前版本的API接口统一

0.4.11

+ 对 UD 的 sAccount 字段做了兼容处理
+ 增加了 `getResourcePath` 接口用于获取资源路径

0.4.10

+ 修改 API 和 SDK 为同步通信
+ 增加 readRoleCookie / writeRoleCookie 接口
+ 优化接口注释

0.4.9 

+ 增加 getAPPInfo 查询接口，传入 appId, appKey , 校验后返回 appVersion, appName, 本接口仅支持 GameletSDK

+ 增加 setAppEnv 接口 允许用户自行设置 App 信息（仅限一个页面中存在多活动在的特殊情况使用），支持 GameletSDK

0.4.8

+ PxIDE 环境下 CanUsePlatformAPI 接口默认返回 false
+ 增加 pluginsForActivityCenter 插件
+ 支持Pandora ueSDK 部分接口
  ```
  GameletAPI.gameCustomFunction()
  GameletAPI.SetDataStash()
  GameletAPI.GetDataStash()
  GameletAPI.ClearDataStash()
  GameletAPI.getUserData()
  ```

0.4.7

+ 更新pxide分支下 getOpenArgs 和 getEntryInfo 返回值改为 "{}"

0.4.6

+ 修复 reportStatsV2 接口在 atm 渠道 goodsId 类型问题,  number->string

0.4.5

+ 修复pandora unity引擎atm上报参数出错的bug

0.4.4（deprecated）

+ 增加了 unity 中 JS 异常的默认 TDM 上报

0.4.3（deprecated）

+ 增加获取引擎版本信息的接口  `getEntryInfo`
+ 增加判断是否支持callbroker的接口 `getIsSupportCallbroker`
+ 在增加获取faas地址的接口 `getFaasAddr`
+ 修复atm接口上报字段

0.4.2

+ 修复 pandoraUnitySDK上 getPlatformDesc 平台判断接口
+ 增加  getIsHitBackendWhitelist 标识是否白名单发布
+ 在白名单发布时支持 close 关闭指定活动的页面
+ reportState 接口暴露 appid 参数

0.4.1

+ 修复 addOnSrvPushDataListener , removeOnSrvPushDataListener 接收服务器推送接口的错误
+ 允许数据虚拟机打开活动页面，但仅在debug打开情况下可用

0.4.0

+ 新增接口
  + 新增 reportStatsV2 统计上报接口，reportMonitorV2 监控上报接口
  + 增加 faas http 上报和日志上报能力
  + 新增 writeCookie, readCookie, deleteCookie 持久化记录接口
  + userdata 中增加 sRegion 字段
+ 支持三方框架
  + 新增DJC  cookie处理接口

0.3.7

+ 修复 Pandora Unity SDK 获取 UD 数据不全的问题

0.3.6

+ 修复 openargs 中不能带=的问题

0.3.5

+ 优化了 Runtime 运行环境的识别方式
  + GameletSDK , PandoraUnitySDK , PxDev 模拟器都可以自动识别
  + 对于旧版本pixui模拟器（VSCode插件中集成的模拟器），可以在URL后手动加参数来设置pxide环境 _sdk_info=openplatform_pxide
  + 请不要用浏览器预览页面，浏览器会被识别为 UNSUPPORT_SDK

0.3.4

+ 修复 userdata 中传入的空字符串会变为 undefined 的问题，让游戏传入和活动获取值保持一致

0.3.3

+ 修复 reportStats， reportToATM 接口中 extendList 参数类型定义

0.3.2

+ 优化接口说明

0.3.1

+ userdata 增加了 sLanguage 字段
+ 优化了 unity 环境下 setGameletAppEnv, 根据传入 appId 或者 appName, 如果用户命中了此活动，则未填写的app信息自动补齐

0.3.0

+ userdata 增加了 sIntlSdkParam 字段。
+ 重写 console.log 让活动默认输出 appId。console.error 错误日志中增加了堆栈。

0.2.11

+ userdata 中增加了 sCountry 和 sLoginChannel 字段