igsdk 1.1.8 → 1.1.10

package/README.md

@@ -227,6 +227,19 @@ export interface ASWAdCallback {
 
 小游戏模块所有功能均在MiniGameSdk下，具体功能如下：
 
+###### 授权
+
+```typescript
+/**
+* 授权
+* @param scope 权限
+* @param callback 回调
+*/
+authorize(scope: string, callback?: MiniGameCallback): void;
+```
+
+
+
 ###### 登录
 
 ```typescript
@@ -381,29 +394,54 @@ setShareMenu(shareOpt: MiniGameShareOpt): void;
  */
 export class MiniGameShareOpt {
 
-    //是否展示分享按钮（被动转发分享时设置）
+    /** 是否展示分享按钮（被动转发分享时设置） */
     public show?: boolean;
-    //分享标题
+    /** 分享标题 */
     public title?: string;
-    //分享描述（仅抖音小游戏时可用）
+    /** 分享描述（仅抖音小游戏时可用） */
     public desc?: string;
-    //审核通过的图片ID （抖音小游戏的templateId）
+    /** 审核通过的图片ID （抖音小游戏的templateId） */
     public imageUrlId?: string;
-    //图片地址
+    /** 图片地址 */
     public imageUrl?: string;
-    //是否使用Canvas 内容作为转发图片 （仅微信小游戏时可用）
+    /** 是否使用Canvas 内容作为转发图片 （仅微信小游戏时可用） */
     public useCanvasImg?: boolean;
-    //是否使用带 shareTicket 的转发 （仅微信小游戏时可用）
+    /** 使用Canvas 内容作为转发图片的可配参数 （仅微信小游戏时可用） */
+    public canvasOpt?: MiniGameWxCanvasShareOpt;
+    /** 是否使用带 shareTicket 的转发 （仅微信小游戏时可用） */
     public withShareTicket?: false;
-    //查询字符串，必须是 key1=val1&key2=val2 的格式
+    /** 查询字符串，必须是 key1=val1&key2=val2 的格式 */
     public query?: string;
-    //审核通过的朋友圈预览图图片ID （仅微信小游戏时可用）
+    /** 审核通过的朋友圈预览图图片ID （仅微信小游戏时可用） */
     public imagePreviewUrlId?: string;
-    //朋友圈预览图链接 （仅微信小游戏时可用）
+    /** 朋友圈预览图链接 （仅微信小游戏时可用） */
     public imagePreviewUrl?: string;
-    //转发内容类型（仅抖音小游戏时可用）
+    /** 转发内容类型（仅抖音小游戏时可用） */
     public channel?: string;
 }
+
+
+/**
+ * 微信Canvas截图分享可配置参数（仅微信小游戏可用）
+ */
+export class MiniGameWxCanvasShareOpt {
+    /** 截取 canvas 的左上角横坐标 */
+    public x?: number;
+    /** 截取 canvas 的左上角纵坐标 */
+    public y?: number;
+    /** 截取 canvas 的宽度 */
+    public width?: number;
+    /** 截取 canvas 的高度 */
+    public height?: number;
+    /** 目标文件的宽度，会将截取的部分拉伸或压缩至该数值 */
+    public destWidth?: number;
+    /** 目标文件的高度，会将截取的部分拉伸或压缩至该数值 */
+    public destHeight?: number;
+    /** 目标文件的类型：jpg：jpg文件，png：png文件 */
+    public fileType?: string;
+    /** jpg图片的质量，仅当 fileType 为 jpg 时有效。取值范围为 0.0（最低）- 1.0（最高），不含 0。不在范围内时当作 1.0 */
+    public quality?: number;
+}
 ```
 
 如果需要主动分享，具体调用如下：
@@ -494,6 +532,68 @@ export class MiniGameOpenCustomerServiceOpt {
 
 
 
+###### 选择媒体文件
+
+```typescript
+/**
+* 选择媒体文件
+* @param chooseMediaOpt 选择媒体文件可配参数
+* @param callback 回调
+*/
+chooseMedia(chooseMediaOpt?: MiniGameChooseMediaOpt, callback?: MiniGameCallback): void;
+
+
+/**
+ * 媒体类型
+ */
+export enum MEDIA_TYPE {
+    /** 图片 */
+    IMAGE = 'image',
+    /** 视频 */
+    VIDEO = 'video',
+    /** 可同时选择图片和视频 */
+    MIX = 'mix'
+}
+
+/**
+ * 来源类型
+ */
+export enum SOURCE_TYPE {
+    /** 从相册选择 */
+    ALBUM = 'album',
+    /** 使用相机拍摄 */
+    CAMERA = 'camera',
+}
+
+/**
+ * 相机类型
+ */
+export enum CAMERA_TYPE {
+    /** 使用后置摄像头 */
+    BACK = 'back',
+    /** 使用前置摄像头 */
+    FRONT = 'front',
+}
+
+/**
+ * 选择媒体文件可配参数
+ */
+export class MiniGameChooseMediaOpt {
+    /** 最多可以选择的数量 */
+    public count?: number;
+    /** 媒体类型 */
+    public mediaType: MEDIA_TYPE;
+    /** 来源类型 */
+    public sourceType: SOURCE_TYPE;
+    /** 拍摄视频最长拍摄时间 */
+    public maxDuration?: number;
+    /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头 */
+    public camera?: CAMERA_TYPE;
+}
+```
+
+
+
 #### 网络请求模块
 
 ###### 设置HTTP请求配置
@@ -564,6 +664,16 @@ get<T extends HttpResData>(path: string, callback?: HttpCallbackBean<T>): void;
 */
 post<T extends HttpResData>(path: string, params?: object, callback?: HttpCallbackBean<T>): void;
 
+/**
+* 上传文件
+* @param path 请求路径
+* @param file 文件路径或文件（小程序里面传文件路径）
+* @param fileName 上传文件名称
+* @param params 请求参数（额外的 form data）
+* @param callback 请求回调
+*/
+uploadFile<T extends HttpResData>(path: string, file: string | Blob, fileName: string, params?: Object, callback?: HttpCallbackBean<T>): void;
+
 
 //构建回调
 let callback = new IG.HttpCallbackBean<LoginResData>();

package/igsdk.d.ts

@@ -12,16 +12,22 @@ declare namespace IG {
      * 参数接口
      */
     interface IParam {
+        /** 将所有属性转为JSON字符串 */
         param(): string;
     }
     /**
      * 初始化可配置参数
      */
     export class InitOpt implements IParam {
+        /** 媒体标识（必传） */
         mediaId: string;
+        /** 自定义渠道标识。广告数据可以根据自定义渠道进行拆分 */
         channel: string;
+        /** 自定义数据，最长255字符。激励视频服务端验证时，该数据会回调给服务器 */
         customData: string;
+        /**  是否显示日志，默认不显示。线上环境应设置成false */
         showLog: boolean;
+        /** 是否打开测试模式。正式上线前请设置为false，否则将不产生收益 */
         test: boolean;
         param(): string;
     }
@@ -29,12 +35,19 @@ declare namespace IG {
      * 广告请求可配置参数
      */
     export class AdOpt implements IParam {
+        /** 广告位id（必传） */
         adId: string;
+        /** 广告回调id */
         callbackId: number;
+        /** 广告容器id */
         containerId: string;
+        /** 广告位置，默认底部 */
         position: AdPosition;
+        /** 垂直距离 */
         margin: number;
+        /** 水平左距离 */
         leftMargin: number;
+        /** 水平右距离 */
         rightMargin: number;
         param(): string;
     }
@@ -147,23 +160,36 @@ declare namespace IG {
      * 初始化参数
      */
     export class ASWInitOpt extends InitOpt {
+        /** Web端媒体id */
         mediaIdWeb: string;
+        /** Android端媒体id */
         mediaIdAndroid: string;
+        /** iOS端媒体id */
         mediaIdIOS: string;
+        /** 鸿蒙端媒体id */
         mediaIdOpenHarmony: string;
     }
     /**
      * 请求广告参数
      */
     export class ASWAdOpt {
+        /** 广告类型 */
         adType: AD_TYPE;
+        /** Web端广告位id */
         adIdWeb: string;
+        /** Android端广告位id */
         adIdAndroid: string;
+        /** iOS端广告位id */
         adIdIOS: string;
+        /** 鸿蒙端广告位id */
         adIdOpenHarmony: string;
+        /** 微信小游戏端广告位id */
         adIdWechatGame: string;
+        /** 抖音小游戏端广告位id */
         adIdDouYinGame: string;
+        /** AdSdk请求广告参数 */
         adOpt: AdOpt;
+        /** MiniGameSdk请求广告参数 */
         miniGameAdOpt: MiniGameAdOpt;
     }
     /**
@@ -246,21 +272,31 @@ declare namespace IG {
      * 广告请求可配置参数
      */
     export class MiniGameAdOpt {
+        /** 广告位id（必传） */
         adId: string;
+        /** 广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 Banner 广告不会自动刷新） */
         adIntervals?: number;
+        /** 广告组件的左上角横坐标 */
         left?: number;
+        /** 广告组件的左上角纵坐标 */
         top?: number;
+        /** 广告组件的宽度 */
         width?: number;
+        /** 广告组件的高度 */
         height?: number;
+        /** 是否开启再得广告模式（只支持安卓系统的抖音和抖音极速版） */
         multiton?: false;
+        /** 再得广告的奖励文案，玩家每看完一个广告都会展示，如【再看1个获得xx】,xx 即 multitonRewardMsg 中的文案，按顺序依次展示，单个文案最大长度为 7，multiton 为 true 时必填 */
         multitonRewardMsg?: [string];
+        /** 额外观看广告的次数，合法的数据范围为 1-4，multiton 为 true 时必填 */
         multitonRewardTimes?: number;
+        /** 是否开启进度提醒，开启时广告文案为【再看N个获得xx】，关闭时为【 再看1个获得xx】。N 表示玩家当前还需额外观看广告的次数。 */
         progressTip?: false;
     }
     /**
      * 请求广告回调接口
      */
-    interface MiniGameAdCallback {
+    export interface MiniGameAdCallback {
         /**
          * 加载广告成功回调
          * @param adId 广告位id
@@ -302,7 +338,7 @@ declare namespace IG {
     /**
      * 小游戏回调接口
      */
-    interface MiniGameCallback {
+    export interface MiniGameCallback {
         /**
          * 成功回调
          * @param res 响应信息
@@ -319,19 +355,28 @@ declare namespace IG {
      * 小游戏用户数据
      */
     export class MiniGameUserData {
+        /** 用户昵称 */
         nick: string;
+        /** 用户头像地址 */
         avatar: string;
+        /** 包括敏感数据在内的完整用户信息的加密数据 */
         encryptedData: string;
+        /** 加密算法的初始向量 */
         iv: string;
     }
     /**
      * 小游戏节点位置信息
      */
     export class MiniGameNodePosition {
+        /** 左上角横坐标 */
         left: number;
+        /** 左上角纵坐标 */
         top: number;
+        /** 宽度 */
         width: number;
+        /** 高度 */
         height: number;
+        /** 是否调试模式（调试模式会展示获取用户信息按钮） */
         debug: boolean;
     }
     /**
@@ -340,47 +385,131 @@ declare namespace IG {
      * 图片优先级：imageUrlId+imageUrl > useCanvasImg > 默认
      */
     export class MiniGameShareOpt {
+        /** 是否展示分享按钮（被动转发分享时设置） */
         show?: boolean;
+        /** 分享标题 */
         title?: string;
+        /** 分享描述（仅抖音小游戏时可用） */
         desc?: string;
+        /** 审核通过的图片ID （抖音小游戏的templateId） */
         imageUrlId?: string;
+        /** 图片地址 */
         imageUrl?: string;
+        /** 是否使用Canvas 内容作为转发图片 （仅微信小游戏时可用） */
         useCanvasImg?: boolean;
+        /** 使用Canvas 内容作为转发图片的可配参数 （仅微信小游戏时可用） */
         canvasOpt?: MiniGameWxCanvasShareOpt;
+        /** 是否使用带 shareTicket 的转发 （仅微信小游戏时可用） */
         withShareTicket?: false;
+        /** 查询字符串，必须是 key1=val1&key2=val2 的格式 */
         query?: string;
+        /** 审核通过的朋友圈预览图图片ID （仅微信小游戏时可用） */
         imagePreviewUrlId?: string;
+        /** 朋友圈预览图链接 （仅微信小游戏时可用） */
         imagePreviewUrl?: string;
+        /** 转发内容类型（仅抖音小游戏时可用） */
         channel?: string;
     }
     /**
      * 微信Canvas截图分享可配置参数（仅微信小游戏可用）
      */
     export class MiniGameWxCanvasShareOpt {
+        /** 截取 canvas 的左上角横坐标 */
         x?: number;
+        /** 截取 canvas 的左上角纵坐标 */
         y?: number;
+        /** 截取 canvas 的宽度 */
         width?: number;
+        /** 截取 canvas 的高度 */
         height?: number;
+        /** 目标文件的宽度，会将截取的部分拉伸或压缩至该数值 */
         destWidth?: number;
+        /** 目标文件的高度，会将截取的部分拉伸或压缩至该数值 */
         destHeight?: number;
+        /** 目标文件的类型：jpg：jpg文件，png：png文件 */
         fileType?: string;
+        /** jpg图片的质量，仅当 fileType 为 jpg 时有效。取值范围为 0.0（最低）- 1.0（最高），不含 0。不在范围内时当作 1.0 */
         quality?: number;
     }
     /**
      * 戏圈按钮可配参数
      */
     export class MiniGameClubButtonOpt extends MiniGameNodePosition {
+        /** 活动页面 */
         openlink: string;
+        /** 传递了openlink值时，此字段生效，决定创建的按钮是否需要拥有红点，默认为true */
         hasRedDot?: boolean;
     }
     /**
      * 打开客服可配参数
      */
     export class MiniGameOpenCustomerServiceOpt {
+        /** 抖音客服类型。1：小 6 客服，2：抖音IM 客服（仅支持抖音），3：抖音客服平台（基础库 3.41.0 开始支持） */
         type?: number;
+        /** 微信客服链接 */
         url?: string;
+        /** 微信客服企业ID */
         corpId?: string;
     }
+    /**
+     * 媒体类型
+     */
+    export enum MEDIA_TYPE {
+        /** 图片 */
+        IMAGE = "image",
+        /** 视频 */
+        VIDEO = "video",
+        /** 可同时选择图片和视频 */
+        MIX = "mix"
+    }
+    /**
+     * 来源类型
+     */
+    export enum SOURCE_TYPE {
+        /** 从相册选择 */
+        ALBUM = "album",
+        /** 使用相机拍摄 */
+        CAMERA = "camera"
+    }
+    /**
+     * 相机类型
+     */
+    export enum CAMERA_TYPE {
+        /** 使用后置摄像头 */
+        BACK = "back",
+        /** 使用前置摄像头 */
+        FRONT = "front"
+    }
+    /**
+     * 选择媒体文件可配参数
+     */
+    export class MiniGameChooseMediaOpt {
+        /** 最多可以选择的数量 */
+        count?: number;
+        /** 媒体类型 */
+        mediaType: MEDIA_TYPE;
+        /** 来源类型 */
+        sourceType: SOURCE_TYPE;
+        /** 拍摄视频最长拍摄时间 */
+        maxDuration?: number;
+        /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头 */
+        camera?: CAMERA_TYPE;
+    }
+    /**
+     * 媒体数据
+     */
+    export class MiniGameMediaData {
+        /** 本地临时文件路径 (本地路径) */
+        tempFilePath: string;
+        /** 本地临时文件大小，单位 B */
+        size: number;
+        /** 视频的时间长度 */
+        duration?: number;
+        /** 视频的高度 */
+        height?: number;
+        /** 视频的宽度 */
+        width?: number;
+    }
     /**
      * 小游戏SDK接口
      */
@@ -418,6 +547,12 @@ declare namespace IG {
          * @param ad 广告
          */
         hideAd(ad: any): void;
+        /**
+         * 授权
+         * @param scope 权限
+         * @param callback 回调
+         */
+        authorize(scope: string, callback?: MiniGameCallback): void;
         /**
          * 登录
          * @param callback 回调
@@ -465,25 +600,37 @@ declare namespace IG {
          * @param callback 回调
          */
         openCustomerService(openCustomerServiceOpt?: MiniGameOpenCustomerServiceOpt, callback?: MiniGameCallback): void;
+        /**
+         * 选择媒体文件
+         * @param chooseMediaOpt 选择媒体文件可配参数
+         * @param callback 回调
+         */
+        chooseMedia(chooseMediaOpt?: MiniGameChooseMediaOpt, callback?: MiniGameCallback): void;
     }
     /**
-     * 小游戏广告SDK
+     * 小游戏SDK
      */
     export class MiniGameSdk implements IMiniGameSdk {
-        private static adSdk;
+        private static sdk;
         private constructor();
         /**
-         * 获取广告SDK实例：单例
-         * @returns 广告SDK实例
+         * 获取SDK实例：单例
+         * @returns SDK实例
          */
         static getInstance(): IMiniGameSdk;
         /**
-         * 检查参数是否合法
+         * 检查SDK
+         * @param callback 回调接口
+         * @returns 是否合法
+         */
+        private checkSdk;
+        /**
+         * 检查广告参数是否合法
          * @param adOpt 请求广告可配参数
          * @param callback 请求广告回调接口
          * @returns 参数是否合法
          */
-        private checkParam;
+        private checkAdParam;
         /**
          * 请求横幅广告
          * @param adOpt 请求广告可配参数
@@ -517,6 +664,12 @@ declare namespace IG {
          * @param ad 广告
          */
         hideAd(ad: any): void;
+        /**
+         * 授权
+         * @param scope 权限
+         * @param callback 回调
+         */
+        authorize(scope: string, callback?: MiniGameCallback): void;
         /**
          * 登录
          * @param callback 登录回调
@@ -565,13 +718,22 @@ declare namespace IG {
         * @param callback 回调
         */
         openCustomerService(openCustomerServiceOpt?: MiniGameOpenCustomerServiceOpt, callback?: MiniGameCallback): void;
+        /**
+         * 选择媒体文件
+         * @param chooseMediaOpt 选择媒体文件可配参数
+         * @param callback 回调
+         */
+        chooseMedia(chooseMediaOpt?: MiniGameChooseMediaOpt, callback?: MiniGameCallback): void;
     }
 
     /**
      * Http请求配置
      */
     export class HttpConfig {
+        /** 请求超时时间（ms） */
         timeout: number;
+        /** 上传文件超时时间（ms） */
+        uploadTimeout: number;
     }
     /**
      * Http请求回调
@@ -608,6 +770,16 @@ declare namespace IG {
          * @param callback 请求回调
          */
         post(url: string, params?: string, headers?: Object, callback?: IHttpCallback): void;
+        /**
+        * 上传文件
+        * @param url 请求地址
+        * @param file 文件路径或文件（小程序里面传文件路径）
+        * @param fileName 上传文件名称
+        * @param params 请求参数（额外的 form data）
+        * @param headers 请求头
+        * @param callback 请求回调
+        */
+        uploadFile(url: string, file: string | Blob, fileName: string, params?: Object, headers?: Object, callback?: IHttpCallback): void;
     }
     /**
      * HTTP请求
@@ -631,6 +803,13 @@ declare namespace IG {
          * 初始化HTTP请求类型
          */
         private static initHttpType;
+        /**
+         * 检查请求参数是否合法
+         * @param url 请求地址
+         * @param callback 请求回调
+         * @returns 参数是否合法
+         */
+        private checkParam;
         /**
          * GET请求
          * @param url 请求地址
@@ -646,25 +825,44 @@ declare namespace IG {
          * @param callback 请求回调
          */
         post(url: string, params?: string, headers?: Object, callback?: IHttpCallback): void;
+        /**
+        * 上传文件
+        * @param url 请求地址
+        * @param file 文件路径或文件（小程序里面传文件路径）
+        * @param fileName 上传文件名称
+        * @param params 请求参数（额外的 form data）
+        * @param headers 请求头
+        * @param callback 请求回调
+        */
+        uploadFile(url: string, file: string | Blob, fileName: string, params?: Object, headers?: Object, callback?: IHttpCallback): void;
     }
 
     /**
      * Http请求配置
      */
     export class HttpWrapperConfig extends HttpConfig {
+        /** 请求基地址 */
         baseUrl?: string;
+        /** 客户端版本号 */
         version?: string;
+        /** 渠道标识 */
         channel?: string;
+        /** 签名前缀 */
         signPrefix?: string;
+        /** AES加密秘钥 */
         key?: string;
+        /** AES加密向量 */
         iv?: string;
     }
     /**
      * Http请求响应基础数据
      */
     export class HttpResData {
+        /** 响应成功 */
         static C_SUC: number;
+        /** 响应码 */
         code: number;
+        /** 响应消息 */
         msg: string;
     }
     /**
@@ -719,6 +917,15 @@ declare namespace IG {
         */
         post<T extends HttpResData>(path: string, params?: object, callback?: HttpCallbackBean<T>): void;
         /**
+        * 上传文件
+        * @param path 请求路径
+        * @param file 文件路径或文件（小程序里面传文件路径）
+        * @param fileName 上传文件名称
+        * @param params 请求参数（额外的 form data）
+        * @param callback 请求回调
+        */
+        uploadFile<T extends HttpResData>(path: string, file: string | Blob, fileName: string, params?: Object, callback?: HttpCallbackBean<T>): void;
+        /**
         * 获取请求地址
         * @param path 请求路径
         */
@@ -822,11 +1029,17 @@ declare namespace IG {
      * 日志等级
      */
     export enum LOG_LEVEL {
+        /** 追踪级别日志 */
         TRACE = 1,
+        /** 调试级别日志 */
         DEBUG = 2,
+        /** 信息级别日志 */
         INFO = 3,
+        /** 警告级别日志 */
         WARN = 4,
+        /** 错误级别日志 */
         ERROR = 5,
+        /** 关闭所有日志 */
         OFF = 6
     }
     /**
@@ -928,28 +1141,46 @@ declare namespace IG {
      * 客户端类型
      */
     export enum CLIENT_TYPE {
+        /** 未获取 */
         UNKNOWN = 0,
+        /** Android原生应用 */
         ANDROID_APP = 1,
+        /** iOS原生应用 */
         IOS_APP = 2,
+        /** 鸿蒙原生应用 */
         HARMONYOS_APP = 3,
+        /** Web端（包含移动端和PC端的H5） */
         WEB = 4,
+        /** 微信小游戏 */
         WECHAT_MINI_GAME = 5,
+        /** 抖音小游戏 */
         DOUYIN_MINI_GAME = 6,
+        /** 支付宝小游戏 */
         ALIPAY_MINI_GAME = 7,
+        /** PC端原生应用 */
         PC_APP = 8,
+        /** 其他 */
         OTHER = 99
     }
     /**
      * 操作系统类型
      */
     export enum OS_TYPE {
+        /** 未获取 */
         UNKNOWN = 0,
+        /** Android（包含其他由Android系统封装的系统） */
         ANDROID = 1,
+        /** iOS */
         IOS = 2,
+        /** 鸿蒙 */
         HARMONYOS_OS = 3,
+        /** Windows */
         WINDOWS = 4,
+        /** Linux */
         LINUX = 5,
+        /** MAC */
         MAC_OS = 6,
+        /** 其他 */
         OTHER = 99
     }
     /**