igsdk 1.1.2 → 1.1.3

package/README.md

@@ -4,15 +4,35 @@
 
 ## SDK简介
 
-iGlees SDK为Cocos开发者提供了广告、网络请求、加解密、缓存数据等功能。
+iGlees SDK为Cocos开发者提供了广告、网络请求、加解密、缓存数据等功能，CocosCreator开发者可以使用该SDK提供的功能快速高效的构建游戏。
 
 
 
 ## SDK集成
 
-#### 说明
+#### 导入SDK
 
-iGlees SDK的所有功能均放在IG命名空间，然后根据具体的功能模块进行调用。比如IG.IGSdk，IG.HttpWrapper等。
+iGlees SDK的所有功能均放在IG命名空间，然后根据具体的功能模块进行调用。比如IG.IGSdk，IG.HttpWrapper等。使用iGlees SDK前，需要先导入SDK。目前支持两种方式导入，具体如下：
+
+###### npm方式导入
+
+```typescript
+//在项目根目录使用npm命令安装iGlees SDK（建议使用最新版本）
+npm install igsdk@latest --save
+
+//代码中导入SDK使用
+import IG from 'igsdk';
+```
+
+###### 手动导入
+
+```typescript
+//1、下载igsdk.js、igsdk.d.ts，将两个文件放入到项目assets目录下的lib目录（具体根据实际情况存放到指定目录），并把igsdk.js设置成插件，并允许web、native、编辑器环境加载
+
+//2、导入SDK，并设置代码提示
+import IG from './lib/igsdk.js';
+/// <reference path="./lib/igsdk.d.ts" />
+```
 
 
 

package/igsdk.d.ts

@@ -1,114 +1,19 @@
 declare namespace IG {
 
     /**
-    * 客户端类型
+    * 广告位置（横幅、模板广告使用）
     */
-    export enum CLIENT_TYPE {
-        UNKNOWN = 0,
-        ANDROID_APP = 1,
-        IOS_APP = 2,
-        HARMONYOS_APP = 3,
-        WEB = 4,
-        WECHAT_MINI_GAME = 5,
-        DOUYIN_MINI_GAME = 6,
-        ALIPAY_MINI_GAME = 7,
-        PC_APP = 8,
-        OTHER = 99
-    }
-
-    /**
-     * 操作系统类型
-     */
-    export enum OS_TYPE {
-        UNKNOWN = 0,
-        ANDROID = 1,
-        IOS = 2,
-        HARMONYOS_OS = 3,
-        WINDOWS = 4,
-        LINUX = 5,
-        MAC_OS = 6,
-        OTHER = 99
-    }
-
-    /**
-     * SDK基类
-     */
-    export class IGSdk {
-        private static sys;
-        private static reflection;
-        private static inited;
-        private static clientType;
-        private static osType;
-        private constructor();
-        /**
-         * 初始化（注：使用SDK功能前调用，只需要调用一次，建议进入首个场景就调用）
-         * @param sys 当前系统对象 （CocosCreator<3.0时传cc.sys，CocosCreator>=3.0时传sys）
-         * @param reflection 反射对象（打包原生平台时需要设置，CocosCreator<=3.5时传jsb.reflection， CocosCreator>=3.6时传native.reflection）
-         * @param logLevel 日志等级
-         * @param 是否初始化成功
-        */
-        static init(sys: any, reflection?: any, logLevel?: LOG_LEVEL): boolean;
-        /**
-        * 获取SDK版本号
-        * @returns SDK版本号
-        */
-        static getVersion(): string;
-        /**
-         * 检查SDK是否已经初始化
-         * @returns 是否已经初始化
-         */
-        static hasInit(): boolean;
-        /**
-         * 获取当前系统对象
-         * @returns 当前系统对象
-         */
-        static getSys(): any;
-        /**
-        * 获取反射对象
-        * @returns 反射对象
-        */
-        static getReflection(): any;
-        /**
-         * 获取客户端类型
-         * @returns 客户端类型
-         */
-        static getClientType(): CLIENT_TYPE;
-        /**
-         * 获取操作系统类型
-         * @returns 操作系统类型
-         */
-        static getOSType(): OS_TYPE;
-        /**
-        * 获取当前运行环境的语言代码，例如 "en-US", "zh-CN"。
-        * @returns 当前运行环境的语言代码
-        */
-        static getLanguage(): any;
-        /**
-         * 初始化客户端类型
-         */
-        private static initClientType;
-        /**
-         * 初始化操作系统类型
-         */
-        private static initOsType;
-    }
-
-    /**
-     * 广告位置（横幅、模板广告使用）
-     */
     export enum AdPosition {
         BOTTOM = 0,
         CENTER = 1,
         TOP = 2
     }
-
     /**
      * 参数接口
      */
     interface IParam {
         param(): string;
     }
-
     /**
      * 初始化可配置参数
      */
@@ -228,7 +133,6 @@ declare namespace IG {
          */
         requestAd(adOpt: AdOpt, callback?: AdCallback): void;
     }
-
     /**
      * 广告请求可配置参数
      */
@@ -414,7 +318,6 @@ declare namespace IG {
          */
         shareAppMessage(shareOpt: MiniGameShareOpt): void;
     }
-
     /**
      * 广告类型（小游戏使用）
      */
@@ -504,7 +407,11 @@ declare namespace IG {
      * 广告SDK
      */
     export class AdSdkWrapper {
-        private static clientType;
+        /**
+         * 获取客户端类型
+         * @returns 客户端类型
+         */
+        private static getClientType;
         /**
          * 初始化广告SDK
          * @param initOpt 初始化可配置参数
@@ -598,7 +505,6 @@ declare namespace IG {
          */
         post(url: string, params?: string, headers?: Object, callback?: IHttpCallback): void;
     }
-
     /**
      * Http请求配置
      */
@@ -864,7 +770,7 @@ declare namespace IG {
         */
         static setDataSafely(key: string, data: any, encryptKey?: string, encryptIv?: string): void;
         /**
-        * 获取缓存数据（数据会解密）
+        * 获取缓存数据
         * @param key 数据key
         * @param encryptKey 加密秘钥（未设置时，使用默认秘钥）
         * @param encryptIv 加密向量（未设置时，使用默认向量）
@@ -872,6 +778,96 @@ declare namespace IG {
         */
         static getDataSafely(key: string, encryptKey?: string, encryptIv?: string): string | null;
     }
+    /**
+     * 客户端类型
+     */
+    export enum CLIENT_TYPE {
+        UNKNOWN = 0,
+        ANDROID_APP = 1,
+        IOS_APP = 2,
+        HARMONYOS_APP = 3,
+        WEB = 4,
+        WECHAT_MINI_GAME = 5,
+        DOUYIN_MINI_GAME = 6,
+        ALIPAY_MINI_GAME = 7,
+        PC_APP = 8,
+        OTHER = 99
+    }
+    /**
+     * 操作系统类型
+     */
+    export enum OS_TYPE {
+        UNKNOWN = 0,
+        ANDROID = 1,
+        IOS = 2,
+        HARMONYOS_OS = 3,
+        WINDOWS = 4,
+        LINUX = 5,
+        MAC_OS = 6,
+        OTHER = 99
+    }
+    /**
+     * SDK基类
+     */
+    export class IGSdk {
+        private static sys;
+        private static reflection;
+        private static inited;
+        private static clientType;
+        private static osType;
+        private constructor();
+        /**
+         * 初始化（注：使用SDK功能前调用，只需要调用一次，建议进入首个场景就调用）
+         * @param sys 当前系统对象 （CocosCreator<3.0时传cc.sys，CocosCreator>=3.0时传sys）
+         * @param reflection 反射对象（打包原生平台时需要设置，CocosCreator<=3.5时传jsb.reflection， CocosCreator>=3.6时传native.reflection）
+         * @param logLevel 日志等级（线上环境设置为LOG_ERROR或OFF）
+         * @param 是否初始化成功
+        */
+        static init(sys: any, reflection?: any, logLevel?: LOG_LEVEL): boolean;
+        /**
+         * 获取SDK版本号
+         * @returns SDK版本号
+         */
+        static getVersion(): string;
+        /**
+         * 检查SDK是否已经初始化
+         * @returns 是否已经初始化
+         */
+        static hasInit(): boolean;
+        /**
+         * 获取当前系统对象
+         * @returns 当前系统对象
+         */
+        static getSys(): any;
+        /**
+        * 获取反射对象
+        * @returns 反射对象
+        */
+        static getReflection(): any;
+        /**
+         * 获取客户端类型
+         * @returns 客户端类型
+         */
+        static getClientType(): CLIENT_TYPE;
+        /**
+         * 获取操作系统类型
+         * @returns 操作系统类型
+         */
+        static getOSType(): OS_TYPE;
+        /**
+        * 获取当前运行环境的语言代码，例如 "en-US", "zh-CN"。
+        * @returns 当前运行环境的语言代码
+        */
+        static getLanguage(): any;
+        /**
+         * 初始化客户端类型
+         */
+        private static initClientType;
+        /**
+         * 初始化操作系统类型
+         */
+        private static initOsType;
+    }
 
 }