igsdk 1.1.5 → 1.1.7

package/README.md

@@ -223,6 +223,233 @@ export interface ASWAdCallback {
 
 
 
+#### 小游戏模块
+
+小游戏模块所有功能均在MiniGameSdk下，具体功能如下：
+
+###### 登录
+
+```typescript
+/**
+* 登录
+* @param callback 登录回调
+*/
+login(callback?: MiniGameLoginCallback): void;
+      
+//登录示例：
+IG.MiniGameSdk.getInstance()?.login({
+    onSuc(code) {
+        console.log('login suc.', code);
+    },
+    onFail(code, msg) {
+        console.error('login fail.', code, msg);
+    }
+});
+```
+
+```typescript
+/**
+ * 登录回调接口
+ */
+interface MiniGameLoginCallback {
+    /**
+     * 登录成功
+     * @param code 登录凭证code
+     */
+    onSuc(code: string): void;
+
+    /**
+     * 登录失败
+     * @param code 错误码
+     * @param msg  错误消息
+     */
+    onFail(code: number, msg: string): void;
+}
+```
+
+
+
+###### 检查登录态
+
+```typescript
+/**
+* 检查登录态 session_key 是否过期
+* @param callback 检查登录态回调
+*/
+checkSession(callback?: MiniGameCheckSessionCallback): void;
+             
+//示例：
+IG.MiniGameSdk.getInstance()?.checkSession({
+    onSuc() {
+        console.log('checkSession suc.');
+    },
+    onFail(code, msg) {
+        console.error('checkSession fail.', code, msg);
+    }
+})            
+```
+
+```typescript
+/**
+ * 检查登录态session_key回调接口
+ */
+interface MiniGameCheckSessionCallback {
+    /**
+     * 未过期，并且在本生命周期一直有效
+     */
+    onSuc(): void;
+
+    /**
+     * 已经失效，需要重新执行登录流程
+     * @param code 错误码
+     * @param msg 错误消息
+     */
+    onFail(code: number, msg: string): void;
+}
+```
+
+
+
+###### 获取用户信息
+
+```typescript
+/**
+* 获取用户信息
+* @param authUserInfoNode 获取用户信息授权按钮的节点信息
+* @param callback 获取用户信息回调
+*/
+getUserInfo(authUserInfoNode?: MiniGameAuthUserInfoNode, callback?: MiniGameUserInfoCallback): void;
+
+
+//示例：
+let interstitialAdNode = find('ButtonLayout/InterstitialAd', this.node);
+console.log(interstitialAdNode);
+let authUserInfoNodeInfo = this.getNodeInScreenRect(interstitialAdNode);
+console.error(authUserInfoNodeInfo);
+IG.MiniGameSdk.getInstance()?.getUserInfo(authUserInfoNodeInfo, {
+    onSuc(data) {
+        console.log('getUserInfo suc.', data);
+    },
+    onFail(code, msg) {
+        console.error('getUserInfo fail.', code, msg);
+    },
+})
+```
+
+```typescript
+/**
+ * 小游戏授权用户信息节点数据（微信小游戏使用）
+ */
+export class MiniGameAuthUserInfoNode {
+    //左上角横坐标
+    public left: number;
+    //左上角纵坐标
+    public top: number;
+    //宽度
+    public width: number;
+    //高度
+    public height: number;
+    //是否调试模式（调试模式会展示获取用户信息按钮）
+    public debug: boolean;
+}
+
+/**
+ * 获取用户信息回调接口
+ */
+interface MiniGameUserInfoCallback {
+    /**
+     * 获取用户信息成功
+     * @param data 小游戏用户数据
+     */
+    onSuc(data: MiniGameUserData): void;
+
+    /**
+     * 获取用户信息失败
+     * @param code 错误码
+     * @param msg  错误消息
+     */
+    onFail(code: number, msg: string): void;
+}
+
+```
+
+
+
+###### 分享
+
+使用分享时，在iGlees SDK初始化之后，先设置展示分享按钮
+
+```typescript
+//展示分享按钮
+IG.MiniGameSdk.getInstance().setShareMenu({
+    show: true
+});
+```
+
+其中设置分享方法即参数如下：
+
+```typescript
+/**
+* 设置分享按钮
+* @param shareOpt 分享可配参数
+*/
+setShareMenu(shareOpt: MiniGameShareOpt): void;
+```
+
+```typescript
+/**
+ * 分享可配置参数
+ * 参数说明：
+ * 图片优先级：imageUrlId+imageUrl > useCanvasImg > 默认
+ */
+export class MiniGameShareOpt {
+
+    //是否展示分享按钮（被动转发分享时设置）
+    public show?: boolean;
+    //分享标题
+    public title?: string;
+    //分享描述（仅抖音小游戏时可用）
+    public desc?: string;
+    //审核通过的图片ID （抖音小游戏的templateId）
+    public imageUrlId?: string;
+    //图片地址
+    public imageUrl?: string;
+    //是否使用Canvas 内容作为转发图片 （仅微信小游戏时可用）
+    public useCanvasImg?: boolean;
+    //是否使用带 shareTicket 的转发 （仅微信小游戏时可用）
+    public withShareTicket?: false;
+    //查询字符串，必须是 key1=val1&key2=val2 的格式
+    public query?: string;
+    //审核通过的朋友圈预览图图片ID （仅微信小游戏时可用）
+    public imagePreviewUrlId?: string;
+    //朋友圈预览图链接 （仅微信小游戏时可用）
+    public imagePreviewUrl?: string;
+    //转发内容类型（仅抖音小游戏时可用）
+    public channel?: string;
+}
+```
+
+如果需要主动分享，具体调用如下：
+
+```typescript
+/**
+* 直接调起分享转发
+* @param shareOpt 分享可配参数
+*/
+shareAppMessage(shareOpt: MiniGameShareOpt): void;
+
+
+//调用示例：
+IG.MiniGameSdk.getInstance().shareAppMessage({
+    title: "我就是牌神",
+    desc: "十三幺就是爽！",
+    imageUrlId: 'testId',
+    imageUrl:'testUrl'
+});
+```
+
+
+
 #### 网络请求模块
 
 ###### 设置HTTP请求配置

package/igsdk.d.ts

@@ -1,8 +1,8 @@
 declare namespace IG {
 
     /**
-    * 广告位置（横幅、模板广告使用）
-    */
+ * 广告位置（横幅、模板广告使用）
+ */
     export enum AdPosition {
         BOTTOM = 0,
         CENTER = 1,
@@ -133,9 +133,118 @@ declare namespace IG {
          */
         requestAd(adOpt: AdOpt, callback?: AdCallback): void;
     }
+
     /**
-     * 广告请求可配置参数
+     * 广告类型（小游戏使用）
+     */
+    export enum AD_TYPE {
+        BANNER = 1,
+        CUSTOM = 2,
+        INTERSTITIAL = 3,
+        REWARD_VIDEO = 4
+    }
+    /**
+     * 初始化参数
+     */
+    export class ASWInitOpt extends InitOpt {
+        mediaIdWeb: string;
+        mediaIdAndroid: string;
+        mediaIdIOS: string;
+        mediaIdOpenHarmony: string;
+    }
+    /**
+     * 请求广告参数
+     */
+    export class ASWAdOpt {
+        adType: AD_TYPE;
+        adIdWeb: string;
+        adIdAndroid: string;
+        adIdIOS: string;
+        adIdOpenHarmony: string;
+        adIdWechatGame: string;
+        adIdDouYinGame: string;
+        adOpt: AdOpt;
+        miniGameAdOpt: MiniGameAdOpt;
+    }
+    /**
+     * 初始化SDK回调接口
      */
+    export interface ASWInitCallback {
+        /**
+         * 初始化SDK回调结果
+         * @param code 响应吗，code=0表示成功
+         * @param msg 响应消息，初始化失败时为具体错误消息
+         */
+        (code: number, msg: string): void;
+    }
+    /**
+     * 请求广告回调接口
+     */
+    export interface ASWAdCallback {
+        /**
+         * 加载广告成功回调
+         * @param adId 广告位id
+         */
+        onAdLoad?(adId: string): void;
+        /**
+         * 广告曝光回调
+         * @param adId 广告位id
+         */
+        onAdShow?(adId: string): void;
+        /**
+         * 广告点击回调（Web平台不一定回调）
+         * @param adId 广告位id
+         */
+        onAdClick?(adId: string): void;
+        /**
+         * 激励视频可以奖励回调
+         * @param adId 广告位id
+         */
+        onAdReward?(adId: string): void;
+        /**
+         * 激励视频观看完成回调
+         * @param adId 广告位id
+         */
+        onAdComplete?(adId: string): void;
+        /**
+         * 广告关闭回调（Web平台不一定回调）
+         * @param adId 广告位id
+         */
+        onAdDismiss?(adId: string): void;
+        /**
+         * 广告加载失败回调
+         * @param adId 广告位id
+         * @param code 错误码
+         * @param msg 错误消息
+         */
+        onAdError?(adId: string, code: number, msg: string): void;
+    }
+    /**
+     * 广告SDK
+     */
+    export class AdSdkWrapper {
+        /**
+         * 获取客户端类型
+         * @returns 客户端类型
+         */
+        private static getClientType;
+        /**
+         * 初始化广告SDK
+         * @param initOpt 初始化可配置参数
+         * @param callback 初始化回调
+         */
+        static init(initOpt: ASWInitOpt, callback?: ASWInitCallback): void;
+        /**
+         * 请求广告
+         * @param adOpt 请求广告可配置参数
+         * @param callback 请求广告回调
+         */
+        static requestAd(adOpt: ASWAdOpt, callback?: ASWAdCallback): void;
+    }
+
+    /**
+ * 广告请求可配置参数
+ */
     export class MiniGameAdOpt {
         adId: string;
         adIntervals?: number;
@@ -190,6 +299,72 @@ declare namespace IG {
          */
         onAdError?(adId: string, code: number, msg: string): void;
     }
+    /**
+     * 登录回调接口
+     */
+    interface MiniGameLoginCallback {
+        /**
+         * 登录成功
+         * @param code 登录凭证code
+         */
+        onSuc(code: string): void;
+        /**
+         * 登录失败
+         * @param code 错误码
+         * @param msg  错误消息
+         */
+        onFail(code: number, msg: string): void;
+    }
+    /**
+     * 检查登录态session_key回调接口
+     */
+    interface MiniGameCheckSessionCallback {
+        /**
+         * 未过期，并且在本生命周期一直有效
+         */
+        onSuc(): void;
+        /**
+         * 已经失效，需要重新执行登录流程
+         * @param code 错误码
+         * @param msg 错误消息
+         */
+        onFail(code: number, msg: string): void;
+    }
+    /**
+     * 小游戏用户数据
+     */
+    export class MiniGameUserData {
+        nick: string;
+        avatar: string;
+        encryptedData: string;
+        iv: string;
+    }
+    /**
+     * 小游戏授权用户信息节点数据（微信小游戏使用）
+     */
+    export class MiniGameAuthUserInfoNode {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+        debug: boolean;
+    }
+    /**
+     * 获取用户信息回调接口
+     */
+    interface MiniGameUserInfoCallback {
+        /**
+         * 获取用户信息成功
+         * @param data 小游戏用户数据
+         */
+        onSuc(data: MiniGameUserData): void;
+        /**
+         * 获取用户信息失败
+         * @param code 错误码
+         * @param msg  错误消息
+         */
+        onFail(code: number, msg: string): void;
+    }
     /**
      * 分享可配置参数
      * 参数说明：
@@ -245,6 +420,22 @@ declare namespace IG {
          * @param ad 广告
          */
         hideAd(ad: any): void;
+        /**
+         * 登录
+         * @param callback 登录回调
+         */
+        login(callback?: MiniGameLoginCallback): void;
+        /**
+         * 检查登录态 session_key 是否过期
+         * @param callback 检查登录态回调
+         */
+        checkSession(callback?: MiniGameCheckSessionCallback): void;
+        /**
+         * 获取用户信息
+         * @param authUserInfoNode 获取用户信息授权按钮的节点信息
+         * @param callback 获取用户信息回调
+         */
+        getUserInfo(authUserInfoNode?: MiniGameAuthUserInfoNode, callback?: MiniGameUserInfoCallback): void;
         /**
          * 设置分享按钮
          * @param shareOpt 分享可配参数
@@ -307,6 +498,22 @@ declare namespace IG {
          * @param ad 广告
          */
         hideAd(ad: any): void;
+        /**
+         * 登录
+         * @param callback 登录回调
+         */
+        login(callback?: MiniGameLoginCallback): void;
+        /**
+        * 检查登录态 session_key 是否过期
+        * @param callback 检查登录态回调
+        */
+        checkSession(callback?: MiniGameCheckSessionCallback): void;
+        /**
+        * 获取用户信息
+        * @param authUserInfoNode 获取用户信息授权按钮的节点信息
+        * @param callback 获取用户信息回调
+        */
+        getUserInfo(authUserInfoNode?: MiniGameAuthUserInfoNode, callback?: MiniGameUserInfoCallback): void;
         /**
          * 设置分享按钮
          * @param shareOpt 分享可配参数
@@ -318,116 +525,10 @@ declare namespace IG {
          */
         shareAppMessage(shareOpt: MiniGameShareOpt): void;
     }
+
     /**
-     * 广告类型（小游戏使用）
-     */
-    export enum AD_TYPE {
-        BANNER = 1,
-        CUSTOM = 2,
-        INTERSTITIAL = 3,
-        REWARD_VIDEO = 4
-    }
-    /**
-     * 初始化参数
-     */
-    export class ASWInitOpt extends InitOpt {
-        mediaIdWeb: string;
-        mediaIdAndroid: string;
-        mediaIdIOS: string;
-        mediaIdOpenHarmony: string;
-    }
-    /**
-     * 请求广告参数
-     */
-    export class ASWAdOpt {
-        adType: AD_TYPE;
-        adIdWeb: string;
-        adIdAndroid: string;
-        adIdIOS: string;
-        adIdOpenHarmony: string;
-        adIdWechatGame: string;
-        adIdDouYinGame: string;
-        adOpt: AdOpt;
-        miniGameAdOpt: MiniGameAdOpt;
-    }
-    /**
-     * 初始化SDK回调接口
-     */
-    export interface ASWInitCallback {
-        /**
-         * 初始化SDK回调结果
-         * @param code 响应吗，code=0表示成功
-         * @param msg 响应消息，初始化失败时为具体错误消息
-         */
-        (code: number, msg: string): void;
-    }
-    /**
-     * 请求广告回调接口
-     */
-    export interface ASWAdCallback {
-        /**
-         * 加载广告成功回调
-         * @param adId 广告位id
-         */
-        onAdLoad?(adId: string): void;
-        /**
-         * 广告曝光回调
-         * @param adId 广告位id
-         */
-        onAdShow?(adId: string): void;
-        /**
-         * 广告点击回调（Web平台不一定回调）
-         * @param adId 广告位id
-         */
-        onAdClick?(adId: string): void;
-        /**
-         * 激励视频可以奖励回调
-         * @param adId 广告位id
-         */
-        onAdReward?(adId: string): void;
-        /**
-         * 激励视频观看完成回调
-         * @param adId 广告位id
-         */
-        onAdComplete?(adId: string): void;
-        /**
-         * 广告关闭回调（Web平台不一定回调）
-         * @param adId 广告位id
-         */
-        onAdDismiss?(adId: string): void;
-        /**
-         * 广告加载失败回调
-         * @param adId 广告位id
-         * @param code 错误码
-         * @param msg 错误消息
-         */
-        onAdError?(adId: string, code: number, msg: string): void;
-    }
-    /**
-     * 广告SDK
-     */
-    export class AdSdkWrapper {
-        /**
-         * 获取客户端类型
-         * @returns 客户端类型
-         */
-        private static getClientType;
-        /**
-         * 初始化广告SDK
-         * @param initOpt 初始化可配置参数
-         * @param callback 初始化回调
-         */
-        static init(initOpt: ASWInitOpt, callback?: ASWInitCallback): void;
-        /**
-         * 请求广告
-         * @param adOpt 请求广告可配置参数
-         * @param callback 请求广告回调
-         */
-        static requestAd(adOpt: ASWAdOpt, callback?: ASWAdCallback): void;
-    }
-    /**
-     * Http请求配置
-     */
+ * Http请求配置
+ */
     export class HttpConfig {
         timeout: number;
     }
@@ -505,6 +606,7 @@ declare namespace IG {
          */
         post(url: string, params?: string, headers?: Object, callback?: IHttpCallback): void;
     }
+
     /**
      * Http请求配置
      */
@@ -602,9 +704,10 @@ declare namespace IG {
          */
         static setToken(token?: string): void;
     }
+
     /**
-     * 加解密工具类
-     */
+ * 加解密工具类
+ */
     export class CryptoUtil {
         private static key;
         private static iv;
@@ -673,9 +776,10 @@ declare namespace IG {
          */
         private static bytesToUUID;
     }
+
     /**
-     * 日志等级
-     */
+ * 日志等级
+ */
     export enum LOG_LEVEL {
         TRACE = 1,
         DEBUG = 2,
@@ -741,8 +845,8 @@ declare namespace IG {
     }
 
     /**
-     * 本地存储工具类
-     */
+ * 本地存储工具类
+ */
     export class StorageUtil {
         /**
          * 检查是否可以缓存
@@ -760,7 +864,7 @@ declare namespace IG {
         * @param key 数据key
         * @returns 数据
         */
-        static getData(key: string): string | null;
+        static getData(key: string): string;
         /**
         * 安全缓存数据（数据会加密）
         * @param key 数据key
@@ -778,6 +882,7 @@ declare namespace IG {
         */
         static getDataSafely(key: string, encryptKey?: string, encryptIv?: string): string | null;
     }
+
     /**
      * 客户端类型
      */
@@ -820,7 +925,7 @@ declare namespace IG {
          * 初始化（注：使用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 logLevel 日志等级
          * @param 是否初始化成功
         */
         static init(sys: any, reflection?: any, logLevel?: LOG_LEVEL): boolean;