igsdk 1.1.6 → 1.1.8

package/README.md

@@ -232,14 +232,14 @@ export interface ASWAdCallback {
 ```typescript
 /**
 * 登录
-* @param callback 登录回调
+* @param callback 回调
 */
-login(callback?: MiniGameLoginCallback): void;
+login(callback?: MiniGameCallback): void;
       
 //登录示例：
 IG.MiniGameSdk.getInstance()?.login({
-    onSuc(code) {
-        console.log('login suc.', code);
+    onSuc(res) {
+        console.log('login suc.', res);
     },
     onFail(code, msg) {
         console.error('login fail.', code, msg);
@@ -249,17 +249,17 @@ IG.MiniGameSdk.getInstance()?.login({
 
 ```typescript
 /**
- * 登录回调接口
+ * 小游戏回调接口
  */
-interface MiniGameLoginCallback {
+interface MiniGameCallback {
     /**
-     * 登录成功
-     * @param code 登录凭证code
+     * 成功回调
+     * @param res 响应信息
      */
-    onSuc(code: string): void;
+    onSuc(res?: any): void;
 
     /**
-     * 登录失败
+     * 失败回调
      * @param code 错误码
      * @param msg  错误消息
      */
@@ -274,9 +274,9 @@ interface MiniGameLoginCallback {
 ```typescript
 /**
 * 检查登录态 session_key 是否过期
-* @param callback 检查登录态回调
+* @param callback 回调
 */
-checkSession(callback?: MiniGameCheckSessionCallback): void;
+checkSession(callback?: MiniGameCallback): void;
              
 //示例：
 IG.MiniGameSdk.getInstance()?.checkSession({
@@ -289,25 +289,6 @@ IG.MiniGameSdk.getInstance()?.checkSession({
 })            
 ```
 
-```typescript
-/**
- * 检查登录态session_key回调接口
- */
-interface MiniGameCheckSessionCallback {
-    /**
-     * 未过期，并且在本生命周期一直有效
-     */
-    onSuc(): void;
-
-    /**
-     * 已经失效，需要重新执行登录流程
-     * @param code 错误码
-     * @param msg 错误消息
-     */
-    onFail(code: number, msg: string): void;
-}
-```
-
 
 
 ###### 获取用户信息
@@ -315,10 +296,10 @@ interface MiniGameCheckSessionCallback {
 ```typescript
 /**
 * 获取用户信息
-* @param authUserInfoNode 获取用户信息授权按钮的节点信息
-* @param callback 获取用户信息回调
+* @param nodePosition 节点位置信息
+* @param callback 回调
 */
-getUserInfo(authUserInfoNode?: MiniGameAuthUserInfoNode, callback?: MiniGameUserInfoCallback): void;
+getUserInfo(nodePosition?: MiniGameNodePosition, callback?: MiniGameCallback): void;
 
 
 //示例：
@@ -338,9 +319,9 @@ IG.MiniGameSdk.getInstance()?.getUserInfo(authUserInfoNodeInfo, {
 
 ```typescript
 /**
- * 小游戏授权用户信息节点数据（微信小游戏使用）
+ * 小游戏节点位置信息
  */
-export class MiniGameAuthUserInfoNode {
+export class MiniGameNodePosition {
     //左上角横坐标
     public left: number;
     //左上角纵坐标
@@ -354,21 +335,17 @@ export class MiniGameAuthUserInfoNode {
 }
 
 /**
- * 获取用户信息回调接口
+ * 小游戏用户数据
  */
-interface MiniGameUserInfoCallback {
-    /**
-     * 获取用户信息成功
-     * @param data 小游戏用户数据
-     */
-    onSuc(data: MiniGameUserData): void;
-
-    /**
-     * 获取用户信息失败
-     * @param code 错误码
-     * @param msg  错误消息
-     */
-    onFail(code: number, msg: string): void;
+export class MiniGameUserData {
+    //用户昵称
+    nick: string;
+    //用户头像地址
+    avatar: string;
+    //包括敏感数据在内的完整用户信息的加密数据
+    encryptedData: string;
+    //加密算法的初始向量
+    iv: string;
 }
 
 ```
@@ -450,6 +427,73 @@ IG.MiniGameSdk.getInstance().shareAppMessage({
 
 
 
+###### 设置
+
+```typescript
+/**
+* 调起客户端小程序设置界面
+* @param callback 回调
+*/
+openSetting(callback: MiniGameCallback): void;
+
+/**
+* 获取用户的当前设置
+* @param callback 回调
+*/
+getSetting(callback: MiniGameCallback): void;
+```
+
+
+
+###### 游戏圈（微信）
+
+```typescript
+/**
+* 创建游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈
+* @param clubButtonOpt 游戏圈按钮可配参数
+*/
+createGameClubButton(clubButtonOpt?: MiniGameClubButtonOpt): any;
+
+                     
+/**
+ * 戏圈按钮可配参数
+ */
+export class MiniGameClubButtonOpt extends MiniGameNodePosition {
+    //活动页面
+    public openlink: string;
+    //传递了openlink值时，此字段生效，决定创建的按钮是否需要拥有红点，默认为true
+    public hasRedDot?: boolean;
+}
+```
+
+
+
+###### 客服
+
+```typescript
+/**
+* 打开客服
+* @param openCustomerServiceOpt 客服可配参数
+* @param callback 回调
+*/
+openCustomerService(openCustomerServiceOpt?: MiniGameOpenCustomerServiceOpt, callback?: MiniGameCallback): void;
+
+
+/**
+ * 打开客服可配参数
+ */
+export class MiniGameOpenCustomerServiceOpt {
+    //抖音客服类型。1：小 6 客服，2：抖音IM 客服（仅支持抖音），3：抖音客服平台（基础库 3.41.0 开始支持）
+    public type?: number;
+    //微信客服链接
+    public url?: string;
+    //微信客服企业ID
+    public corpId?: string;
+}
+```
+
+
+
 #### 网络请求模块
 
 ###### 设置HTTP请求配置

package/igsdk.d.ts

@@ -243,8 +243,8 @@ declare namespace IG {
     }
 
     /**
- * 广告请求可配置参数
- */
+     * 广告请求可配置参数
+     */
     export class MiniGameAdOpt {
         adId: string;
         adIntervals?: number;
@@ -300,36 +300,21 @@ declare namespace IG {
         onAdError?(adId: string, code: number, msg: string): void;
     }
     /**
-     * 登录回调接口
+     * 小游戏回调接口
      */
-    interface MiniGameLoginCallback {
+    interface MiniGameCallback {
         /**
-         * 登录成功
-         * @param code 登录凭证code
+         * 成功回调
+         * @param res 响应信息
          */
-        onSuc(code: string): void;
+        onSuc(res?: any): 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;
-    }
     /**
      * 小游戏用户数据
      */
@@ -340,31 +325,15 @@ declare namespace IG {
         iv: string;
     }
     /**
-     * 小游戏授权用户信息节点数据（微信小游戏使用）
+     * 小游戏节点位置信息
      */
-    export class MiniGameAuthUserInfoNode {
+    export class MiniGameNodePosition {
         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;
-    }
     /**
      * 分享可配置参数
      * 参数说明：
@@ -377,12 +346,41 @@ declare namespace IG {
         imageUrlId?: string;
         imageUrl?: string;
         useCanvasImg?: boolean;
+        canvasOpt?: MiniGameWxCanvasShareOpt;
         withShareTicket?: false;
         query?: string;
         imagePreviewUrlId?: string;
         imagePreviewUrl?: string;
         channel?: string;
     }
+    /**
+     * 微信Canvas截图分享可配置参数（仅微信小游戏可用）
+     */
+    export class MiniGameWxCanvasShareOpt {
+        x?: number;
+        y?: number;
+        width?: number;
+        height?: number;
+        destWidth?: number;
+        destHeight?: number;
+        fileType?: string;
+        quality?: number;
+    }
+    /**
+     * 戏圈按钮可配参数
+     */
+    export class MiniGameClubButtonOpt extends MiniGameNodePosition {
+        openlink: string;
+        hasRedDot?: boolean;
+    }
+    /**
+     * 打开客服可配参数
+     */
+    export class MiniGameOpenCustomerServiceOpt {
+        type?: number;
+        url?: string;
+        corpId?: string;
+    }
     /**
      * 小游戏SDK接口
      */
@@ -422,20 +420,20 @@ declare namespace IG {
         hideAd(ad: any): void;
         /**
          * 登录
-         * @param callback 登录回调
+         * @param callback 回调
          */
-        login(callback?: MiniGameLoginCallback): void;
+        login(callback?: MiniGameCallback): void;
         /**
          * 检查登录态 session_key 是否过期
-         * @param callback 检查登录态回调
+         * @param callback 回调
          */
-        checkSession(callback?: MiniGameCheckSessionCallback): void;
+        checkSession(callback?: MiniGameCallback): void;
         /**
          * 获取用户信息
-         * @param authUserInfoNode 获取用户信息授权按钮的节点信息
-         * @param callback 获取用户信息回调
+         * @param nodePosition 节点位置信息
+         * @param callback 回调
          */
-        getUserInfo(authUserInfoNode?: MiniGameAuthUserInfoNode, callback?: MiniGameUserInfoCallback): void;
+        getUserInfo(nodePosition?: MiniGameNodePosition, callback?: MiniGameCallback): void;
         /**
          * 设置分享按钮
          * @param shareOpt 分享可配参数
@@ -446,6 +444,27 @@ declare namespace IG {
          * @param shareOpt 分享可配参数
          */
         shareAppMessage(shareOpt: MiniGameShareOpt): void;
+        /**
+         * 调起客户端小程序设置界面
+         * @param callback 回调
+         */
+        openSetting(callback: MiniGameCallback): void;
+        /**
+         * 获取用户的当前设置
+         * @param callback 回调
+         */
+        getSetting(callback: MiniGameCallback): void;
+        /**
+         * 创建游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈
+         * @param clubButtonOpt 游戏圈按钮可配参数
+         */
+        createGameClubButton(clubButtonOpt?: MiniGameClubButtonOpt): any;
+        /**
+         * 打开客服
+         * @param openCustomerServiceOpt 客服可配参数
+         * @param callback 回调
+         */
+        openCustomerService(openCustomerServiceOpt?: MiniGameOpenCustomerServiceOpt, callback?: MiniGameCallback): void;
     }
     /**
      * 小游戏广告SDK
@@ -502,18 +521,18 @@ declare namespace IG {
          * 登录
          * @param callback 登录回调
          */
-        login(callback?: MiniGameLoginCallback): void;
+        login(callback?: MiniGameCallback): void;
         /**
         * 检查登录态 session_key 是否过期
         * @param callback 检查登录态回调
         */
-        checkSession(callback?: MiniGameCheckSessionCallback): void;
+        checkSession(callback?: MiniGameCallback): void;
         /**
         * 获取用户信息
-        * @param authUserInfoNode 获取用户信息授权按钮的节点信息
+        * @param nodePosition 节点位置信息
         * @param callback 获取用户信息回调
         */
-        getUserInfo(authUserInfoNode?: MiniGameAuthUserInfoNode, callback?: MiniGameUserInfoCallback): void;
+        getUserInfo(nodePosition?: MiniGameNodePosition, callback?: MiniGameCallback): void;
         /**
          * 设置分享按钮
          * @param shareOpt 分享可配参数
@@ -524,11 +543,33 @@ declare namespace IG {
          * @param shareOpt 分享可配参数
          */
         shareAppMessage(shareOpt: MiniGameShareOpt): void;
+        /**
+         * 调起客户端小程序设置界面
+         * @param callback 回调
+         */
+        openSetting(callback: MiniGameCallback): void;
+        /**
+         * 获取用户的当前设置
+         * @param callback 回调
+         */
+        getSetting(callback: MiniGameCallback): void;
+        /**
+        * 创建游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈
+        * @param clubButtonOpt 游戏圈按钮可配参数
+        * @returns 游戏圈按钮
+        */
+        createGameClubButton(clubButtonOpt?: MiniGameClubButtonOpt): any;
+        /**
+        * 打开客服
+        * @param openCustomerServiceOpt 客服可配参数
+        * @param callback 回调
+        */
+        openCustomerService(openCustomerServiceOpt?: MiniGameOpenCustomerServiceOpt, callback?: MiniGameCallback): void;
     }
 
     /**
- * Http请求配置
- */
+     * Http请求配置
+     */
     export class HttpConfig {
         timeout: number;
     }
@@ -706,8 +747,8 @@ declare namespace IG {
     }
 
     /**
- * 加解密工具类
- */
+     * 加解密工具类
+     */
     export class CryptoUtil {
         private static key;
         private static iv;
@@ -778,8 +819,8 @@ declare namespace IG {
     }
 
     /**
- * 日志等级
- */
+     * 日志等级
+     */
     export enum LOG_LEVEL {
         TRACE = 1,
         DEBUG = 2,
@@ -845,8 +886,8 @@ declare namespace IG {
     }
 
     /**
- * 本地存储工具类
- */
+     * 本地存储工具类
+     */
     export class StorageUtil {
         /**
          * 检查是否可以缓存