概述

SDK提供丰富的聚合API，可以方便的调起提供的能力，如登录、存档、配置、支付等。

API约定

通常，API的命名遵循以下规则1.3.0版本以下，API可能会有部分差异

事件监听

我们约定，以on开头的API用来监听某个事件是否触发，以off开头的API用来注销该监听。这类API的方法，统一为传入一个仅代一个参数的回调函数

Unity

Seeg.OnXXX((res)=>
{

});

CocosCreator

seeg.onXXX((res)=>{

});

同步方法

我们约定，以get或set开头（请注意，若非以此开头，则无该规律），以Sync结尾的API都是同步API

同步 API 的执行结果可以通过函数返回值直接获取，如果执行出错会抛出异常。

Unity

var data = Seeg.GetStorageSync<T>(name);
Seeg.SetStorageSync(name, "val");

CocosCreator

seeg.getStorageSync(name);
seeg.setStorageSync(name, "val");

异步方法

大多数API都是异步 API，这类API接口通常都接受一个Object类型的参数，这个参数都支持按需指定以下字段来接收接口调用结果：

Object参数说明

参数名	类型	必填	说明
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）
其他	Any	-	接口定义的其他参数

上报方法

事件统计方法以track开头

例外

通用事件上报方法为reportEvent

API集合

设备

震动

名称	功能
vibrateShort	使手机发生较短时间的振动（15 ms）
vibrateLong	使手机发生较长时间的振动（400 ms）

API解释

1. 原生和小游戏

• 原生是指通过发布(上架)apk(/aab)或iap等方式提供给用户，小游戏是指借助平台能力提供给用户，因此文档中提到的android或ios没有特殊语境，一般都指原生应用。

2. API的tab页

• Unity 对应 unity插件 的api，适配了小游戏和原生
• CocosCreator 对应 CocosCreator插件 的api, 适配了小游戏和原生
• Android 对应 Andorid原生 的api，仅供Android原生环境使用
• iOS 对应 iOS原生 的api，仅供iOS原生环境使用
  因此，我们建议直接使用插件的api调用，可以一套代码多端通用。

3. API注释里的不支持java/oc直接调用

• 这里并不是指不支持原生，而是不支持原生方法直接调用，可以通过插件提供的api调用。