igsdk 1.1.1

package/igsdk.d.ts

@@ -0,0 +1,879 @@
+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;
+    }
+
+    /**
+     * 初始化可配置参数
+     */
+    export class InitOpt implements IParam {
+        mediaId: string;
+        channel: string;
+        customData: string;
+        showLog: boolean;
+        test: boolean;
+        param(): string;
+    }
+    /**
+     * 广告请求可配置参数
+     */
+    export class AdOpt implements IParam {
+        adId: string;
+        callbackId: number;
+        containerId: string;
+        position: AdPosition;
+        margin: number;
+        leftMargin: number;
+        rightMargin: number;
+        param(): string;
+    }
+    /**
+     * 初始化SDK回调接口
+     */
+    export interface InitCallback {
+        /**
+         * 初始化SDK回调结果
+         * @param code 响应吗，code=0表示成功
+         * @param msg 响应消息，初始化失败时为具体错误消息
+         */
+        (code: number, msg: string): void;
+    }
+    /**
+     * 请求广告回调接口
+     */
+    export interface AdCallback {
+        /**
+         * 加载广告成功回调
+         * @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 interface IAdSdk {
+        /**
+         * 初始化SDK
+         * @param initOpt  初始化可配参数
+         * @param callback 初始化回调接口
+         */
+        init(initOpt: InitOpt, callback?: InitCallback): void;
+        /**
+         * 请求广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         */
+        requestAd(adOpt: AdOpt, callback?: AdCallback): void;
+    }
+    /**
+     * 广告SDK
+     */
+    export class AdSdk implements IAdSdk {
+        private static adSdk;
+        hasInit: boolean;
+        private constructor();
+        /**
+         * 获取广告SDK实例：单例
+         * @returns 广告SDK实例
+         */
+        static getInstance(): IAdSdk;
+        /**
+         * 初始化广告SDK
+         * @param initOpt 初始化可配置参数
+         * @param callback 初始化回调
+         */
+        init(initOpt: InitOpt, callback?: InitCallback): void;
+        /**
+         * 请求广告
+         * @param adOpt 请求广告可配置参数
+         * @param callback 请求广告回调
+         */
+        requestAd(adOpt: AdOpt, callback?: AdCallback): void;
+    }
+
+    /**
+     * 广告请求可配置参数
+     */
+    export class MiniGameAdOpt {
+        adId: string;
+        adIntervals?: number;
+        left?: number;
+        top?: number;
+        width?: number;
+        height?: number;
+        multiton?: false;
+        multitonRewardMsg?: [string];
+        multitonRewardTimes?: number;
+        progressTip?: false;
+    }
+    /**
+     * 请求广告回调接口
+     */
+    interface MiniGameAdCallback {
+        /**
+         * 加载广告成功回调
+         * @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;
+    }
+    /**
+     * 分享可配置参数
+     * 参数说明：
+     * 图片优先级：imageUrlId+imageUrl > useCanvasImg > 默认
+     */
+    export class MiniGameShareOpt {
+        show?: boolean;
+        title?: string;
+        desc?: string;
+        imageUrlId?: string;
+        imageUrl?: string;
+        useCanvasImg?: boolean;
+        withShareTicket?: false;
+        query?: string;
+        imagePreviewUrlId?: string;
+        imagePreviewUrl?: string;
+        channel?: string;
+    }
+    /**
+     * 小游戏SDK接口
+     */
+    interface IMiniGameSdk {
+        /**
+         * 请求横幅广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestBannerAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 请求原生模板广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestCustomAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 请求插屏广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestInterstitialAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 请求激励视频广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestRewardedVideoAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 隐藏广告
+         * @param ad 广告
+         */
+        hideAd(ad: any): void;
+        /**
+         * 设置分享按钮
+         * @param shareOpt 分享可配参数
+         */
+        setShareMenu(shareOpt: MiniGameShareOpt): void;
+        /**
+         * 直接调起分享转发
+         * @param shareOpt 分享可配参数
+         */
+        shareAppMessage(shareOpt: MiniGameShareOpt): void;
+    }
+    /**
+     * 小游戏广告SDK
+     */
+    export class MiniGameSdk implements IMiniGameSdk {
+        private static adSdk;
+        private constructor();
+        /**
+         * 获取广告SDK实例：单例
+         * @returns 广告SDK实例
+         */
+        static getInstance(): IMiniGameSdk;
+        /**
+         * 检查参数是否合法
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 参数是否合法
+         */
+        private checkParam;
+        /**
+         * 请求横幅广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestBannerAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 请求原生模板广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestCustomAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 请求插屏广告
+          * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestInterstitialAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 请求激励视频广告
+         * @param adOpt 请求广告可配参数
+         * @param callback 请求广告回调接口
+         * @returns 广告
+         */
+        requestRewardedVideoAd(adOpt: MiniGameAdOpt, callback?: MiniGameAdCallback): any;
+        /**
+         * 隐藏广告
+         * @param ad 广告
+         */
+        hideAd(ad: any): void;
+        /**
+         * 设置分享按钮
+         * @param shareOpt 分享可配参数
+         */
+        setShareMenu(shareOpt: MiniGameShareOpt): void;
+        /**
+         * 直接调起分享转发
+         * @param shareOpt 分享可配参数
+         */
+        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 {
+        private static clientType;
+        /**
+         * 初始化广告SDK
+         * @param initOpt 初始化可配置参数
+         * @param callback 初始化回调
+         */
+        static init(initOpt: ASWInitOpt, callback?: ASWInitCallback): void;
+        /**
+         * 请求广告
+         * @param adOpt 请求广告可配置参数
+         * @param callback 请求广告回调
+         */
+        static requestAd(adOpt: ASWAdOpt, callback?: ASWAdCallback): void;
+    }
+    /**
+     * Http请求配置
+     */
+    export class HttpConfig {
+        timeout: number;
+    }
+    /**
+     * Http请求回调
+     */
+    export interface IHttpCallback {
+        /**
+         * 请求成功回调
+         * @param data 响应数据
+         */
+        onSuc?(data: string): void;
+        /**
+         * 请求失败回调
+         * @param code 错误码
+         * @param msg 错误消息
+         */
+        onFail?(code: number, msg: string): void;
+    }
+    /**
+     * Http请求接口
+     */
+    export interface IHttp {
+        /**
+         * GET请求
+         * @param url 请求地址
+         * @param headers 自定义请求头
+         * @param callback 请求回调
+         */
+        get(url: string, headers?: Object, callback?: IHttpCallback): void;
+        /**
+         * POST请求
+         * @param url 请求地址
+         * @param params 请求参数（JSON串）
+         * @param headers 请求头
+         * @param callback 请求回调
+         */
+        post(url: string, params?: string, headers?: Object, callback?: IHttpCallback): void;
+    }
+    /**
+     * HTTP请求
+     */
+    export class Http implements IHttp {
+        private static httpConfig;
+        private static httpType;
+        private http;
+        constructor();
+        /**
+        * 设置Http请求配置（全局配置，需请求之前设置）
+        * @param httpConfig Http请求配置
+        */
+        static setConfig(httpConfig: HttpConfig): void;
+        /**
+         * 获取请求配置
+         * @returns 请求配置
+         */
+        static getConfig(): HttpConfig;
+        /**
+         * 初始化HTTP请求类型
+         */
+        private static initHttpType;
+        /**
+         * GET请求
+         * @param url 请求地址
+         * @param headers 自定义请求头
+         * @param callback 请求回调
+         */
+        get(url: string, headers?: Object, callback?: IHttpCallback): void;
+        /**
+         * POST请求
+         * @param url 请求地址
+         * @param params 请求参数（JSON串）
+         * @param headers 请求头
+         * @param callback 请求回调
+         */
+        post(url: string, params?: string, headers?: Object, callback?: IHttpCallback): void;
+    }
+
+    /**
+     * Http请求配置
+     */
+    export class HttpWrapperConfig extends HttpConfig {
+        baseUrl?: string;
+        version?: string;
+        channel?: string;
+        signPrefix?: string;
+        key?: string;
+        iv?: string;
+    }
+    /**
+     * Http请求响应基础数据
+     */
+    export class HttpResData {
+        static C_SUC: number;
+        code: number;
+        msg: string;
+    }
+    /**
+     * HTTP请求回调Bean
+     */
+    export class HttpCallbackBean<T extends HttpResData> implements IHttpCallback {
+        onSuc?(data: string): void;
+        onFail?(code: number, msg: string): void;
+        /**
+         * 检查响应数据合法性
+         * @param data 响应数据
+         */
+        private checkData;
+        /**
+         * 响应数据回调
+         * @param data 响应数据
+         */
+        onRes(data: T): void;
+    }
+    /**
+     * Http请求封装类
+     */
+    export class HttpWrapper {
+        private static readonly KEY_UUID;
+        private static readonly KEY_TOKEN;
+        private static httpConfig;
+        private static token?;
+        private static uuid?;
+        private http;
+        constructor();
+        /**
+         * 设置Http请求配置（请求之前设置）
+         * @param httpConfig Http请求配置
+         */
+        static setConfig(httpConfig: HttpWrapperConfig): void;
+        /**
+         * 获取请求配置
+         * @returns 请求配置
+         */
+        static getConfig(): HttpWrapperConfig;
+        /**
+         * GET请求
+         * @param path 请求路径
+         * @param callback 请求回调
+         */
+        get<T extends HttpResData>(path: string, callback?: HttpCallbackBean<T>): void;
+        /**
+        * POST请求
+        * @param path 请求路径
+        * @param params 请求参数
+        * @param callback 请求回调
+        */
+        post<T extends HttpResData>(path: string, params?: object, callback?: HttpCallbackBean<T>): void;
+        /**
+        * 获取请求地址
+        * @param path 请求路径
+        */
+        private getUrl;
+        /**
+         * 获取请求头
+         * @param encryptedData 加密后的数据
+         * @returns 请求头
+         */
+        private getHeaders;
+        /**
+        * 获取唯一标识
+        * @returns 唯一标识uuid
+        */
+        static getUUID(): string;
+        /**
+         * 获取token
+         * @returns token
+         */
+        static getToken(): string;
+        /**
+         * 缓存当前token
+         * @param token token
+         */
+        static setToken(token?: string): void;
+    }
+    /**
+     * 加解密工具类
+     */
+    export class CryptoUtil {
+        private static key;
+        private static iv;
+        /**
+         * 设置配置（未设置时使用默认秘钥、向量）
+         * @param key 秘钥
+         * @param iv 向量
+         */
+        static setKey(key: string, iv?: string): void;
+        /**
+         * 获取秘钥
+         * @param key 当前设置的秘钥
+         * @returns  秘钥
+         */
+        private static getKey;
+        /**
+         * 获取向量
+         * @param iv 当前设置的向量
+         * @returns 向量
+         */
+        private static getIv;
+        /**
+         * MD5（32位小写）
+         * @param data 需要MD5的数据
+         * @returns MD5后的数据
+         */
+        static md5(data: string): any;
+        /**
+         * AES加密
+         * @param data 需要AES加密的数据
+         * @param key 秘钥（未设置时，使用默认秘钥）
+         * @param iv 向量（未设置时，使用默认向量）
+         * @returns AES加密后的数据
+         */
+        static aesEncrypty(data: string, key?: string, iv?: string): any;
+        /**
+         * AES解密
+         * @param data 需要AES解密的数据
+         * @param key 秘钥（未设置时，使用默认秘钥）
+         * @param iv 向量（未设置时，使用默认向量）
+         * @returns AES解密后的数据
+         */
+        static aesDecrypt(data: string, key?: string, iv?: string): any;
+        /**
+         * Base64加密
+         * @param data 需要Base64加密的数据
+         * @returns Base64加密后的数据
+         */
+        static base64Encrpty(data: string): any;
+        /**
+         * BASE64 解密
+         * @param data 需要Base64解密的数据
+         * @returns Base64解密后的数据
+         */
+        static base64Decrypt(data: string): any;
+        /**
+        * 生成符合UUID v4标准的唯一标识（优化版）
+        */
+        static uuid(): string;
+        /**
+         * 增强的兜底随机数生成
+         */
+        private static enhancedFallback;
+        /**
+         * 高效字节转UUID字符串
+         */
+        private static bytesToUUID;
+    }
+    /**
+     * 日志等级
+     */
+    export enum LOG_LEVEL {
+        TRACE = 1,
+        DEBUG = 2,
+        INFO = 3,
+        WARN = 4,
+        ERROR = 5,
+        OFF = 6
+    }
+    /**
+     * 日志工具
+     */
+    export class LogUtil {
+        private static readonly LOG_TAG;
+        private static logLevel;
+        /**
+         * 日志级别
+         * @param logLevel 日志级别
+         */
+        static setLogLevel(logLevel: LOG_LEVEL): void;
+        /**
+         * 追踪日志
+         * @param message 日志信息
+         * @param optionalParams 日志参数
+         */
+        static trace(message?: any, ...optionalParams: any[]): void;
+        /**
+         * 调试日志
+         * @param message 日志信息
+         * @param optionalParams 日志参数
+         */
+        static debug(message?: any, ...optionalParams: any[]): void;
+        /**
+         * 信息日志
+         * @param message 日志信息
+         * @param optionalParams 日志参数
+         */
+        static info(message?: any, ...optionalParams: any[]): void;
+        /**
+        * 警告日志
+        * @param message 日志信息
+        * @param optionalParams 日志参数
+        */
+        static warn(message?: any, ...optionalParams: any[]): void;
+        /**
+        * 错误日志
+        * @param message 日志信息
+        * @param optionalParams 日志参数
+        */
+        static error(message?: any, ...optionalParams: any[]): void;
+        /**
+        * 打印日志（DEBUG级别日志）
+        * @param message 日志信息
+        * @param optionalParams 日志参数
+        */
+        static log(message?: any, ...optionalParams: any[]): void;
+        /**
+        * 打印日志
+        * @param logLevel 日志级别
+        * @param message 日志信息
+        * @param optionalParams 日志参数
+        */
+        private static printLog;
+    }
+
+    /**
+     * 本地存储工具类
+     */
+    export class StorageUtil {
+        /**
+         * 检查是否可以缓存
+         * @param key 数据key
+         */
+        private static checkAvailable;
+        /**
+        * 缓存数据
+        * @param key 数据key
+        * @param data 数据
+        */
+        static setData(key: string, data: any): void;
+        /**
+        * 获取缓存数据
+        * @param key 数据key
+        * @returns 数据
+        */
+        static getData(key: string): string | null;
+        /**
+        * 安全缓存数据（数据会加密）
+        * @param key 数据key
+        * @param data 数据
+        * @param encryptKey 加密秘钥（未设置时，使用默认秘钥）
+        * @param encryptIv 加密向量（未设置时，使用默认向量）
+        */
+        static setDataSafely(key: string, data: any, encryptKey?: string, encryptIv?: string): void;
+        /**
+        * 获取缓存数据（数据会解密）
+        * @param key 数据key
+        * @param encryptKey 加密秘钥（未设置时，使用默认秘钥）
+        * @param encryptIv 加密向量（未设置时，使用默认向量）
+        * @returns 数据
+        */
+        static getDataSafely(key: string, encryptKey?: string, encryptIv?: string): string | null;
+    }
+
+}
+
+export = IG;
+export as namespace IG;