@dcloudio/uni-app-x 0.7.13 → 0.7.15

package/types/uni/uts-plugin-api/lib/uni-getProvider/utssdk/interface.d.ts

@@ -1,84 +1,188 @@
 export type GetProviderSuccess = {
-    /**
-     * 服务类型
-     * - oauth: 授权登录
-     * - share: 分享
-     * - payment: 支付
-     * - push: 推送
-     * - location: 定位
-     * @type 'oauth' | 'share' | 'payment' | 'push' ｜ 'location'
-     */
-    service: 'oauth' | 'share' | 'payment' | 'push' | 'location',
-    /**
-     * 得到的服务供应商
-     * @type PlusShareShareService['id'][] | PlusPushClientInfo['id'][] | PlusOauthAuthService['id'][] | PlusPaymentPaymentChannel['id'][]
-     */
-    provider: string[],
-    /**
-     * 描述信息
-     */
-    errMsg: string
+	/**
+	 * 服务类型
+	 * - payment: 支付
+	 * @type 'payment'
+	 */
+	service : 'payment',
+	/**
+	 * 得到的服务供应商
+	 * @type PlusShareShareService['id'][] | PlusPushClientInfo['id'][] | PlusOauthAuthService['id'][] | PlusPaymentPaymentChannel['id'][]
+	 */
+	provider : string[],
+	/**
+	 * 得到的服务供应商服务对象
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	providers : UniProvider[],
+	/**
+	 * 错误信息
+	 */
+	errMsg : string
 };
-export type GetProviderSuccessCallback = (result: GetProviderSuccess) => void;
+export type GetProviderSuccessCallback = (result : GetProviderSuccess) => void;
 export type GetProviderFail = UniError;
-export type GetProviderFailCallback = (result: GetProviderFail) => void;
+export type GetProviderFailCallback = (result : GetProviderFail) => void;
 export type GetProviderComplete = any;
-export type GetProviderCompleteCallback = (result: GetProviderComplete) => void;
+export type GetProviderCompleteCallback = (result : GetProviderComplete) => void;
 export type GetProviderOptions = {
-    /**
-     * 服务类型，可取值“oauth”、“share”、“payment”、“push”、“location”
-     * - oauth: 授权登录
-     * - share: 分享
-     * - payment: 支付
-     * - push: 推送
-     * - location: 定位
-     * @type 'oauth' | 'share' | 'payment' | 'push' ｜ 'location'
-     */
-    service: 'oauth' | 'share' | 'payment' | 'push' | 'location',
-    /**
-     * 接口调用成功的回调
-     */
-    success?: GetProviderSuccessCallback | null,
-    /**
-     * 接口调用失败的回调函数
-     */
-    fail?: GetProviderFailCallback | null,
-    /**
-     * 接口调用结束的回调函数（调用成功、失败都会执行）
-     */
-    complete?: GetProviderCompleteCallback | null
+	/**
+	 * 服务类型，可取值“payment”
+	 * - payment: 支付 (Alipay、Wxpay)
+	 * @type 'payment'
+	 */
+	service : 'payment',
+	/**
+	 * 接口调用成功的回调
+	 */
+	success ?: GetProviderSuccessCallback | null,
+	/**
+	 * 接口调用失败的回调函数
+	 */
+	fail ?: GetProviderFailCallback | null,
+	/**
+	 * 接口调用结束的回调函数（调用成功、失败都会执行）
+	 */
+	complete ?: GetProviderCompleteCallback | null
 };
 
-export type GetProvider = (options: GetProviderOptions) => void;
+export type GetProvider = (options : GetProviderOptions) => void;
+
+export type GetProviderIds = (options : GetProviderIdsOptions) => string[] | null;
+
+export type GetProviderObject = (options : GetProviderObjectOptions) => UniProvider | null;
+
+export type GetProviderIdsOptions = {
+	/**
+	 * 服务类型，可取值“payment”
+	 * - payment: 支付 (Alipay、Wxpay)
+	 * @type 'payment'
+	 */
+	service : 'payment',
+};
+
+export type GetProviderObjectOptions = {
+	/**
+	 * 服务类型，可取值“payment”
+	 * - payment: 支付 (Alipay、Wxpay)
+	 */
+	service : 'payment',
+
+	/**
+	 * 服务供应商
+	 */
+	provider : string
+};
 
 export interface Uni {
-  /**
-   * 获取服务供应商
-   * @param {GetProviderOptions} options
-   * @return {void}
-   * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html
-   * @uniPlatform {
-   *  "app": {
-   *    "android": {
-   *      "osVer": "5.0",
-   *      "uniVer": "√",
-   *      "unixVer": "4.11"
-   *    },
-   *    "ios": {
-   *      "osVer": "9.0",
-   *      "uniVer": "√",
+	/**
+	 * 获取服务供应商
+	 * @deprecated 已废弃（仅为了兼容uni1的规范）
+	 *
+	 * @param {GetProviderOptions} options
+	 * @return {void}
+	 * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/plugins/provider.html#getprovider
+	 * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html
+	 * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.11"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "harmony": {
+	 *      "osVer": "3.0",
+	 *      "uniVer": "4.24",
+	 *      "unixVer": "x"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	getProvider(options : GetProviderOptions) : void;
+	/**
+	 * 获取服务供应商ids
+	 * @param {GetProviderIdsOptions} options
+	 * @return {string[] | null} 服务提供商
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.19"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.19"
+	 *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	getProviderIds(options : GetProviderIdsOptions) : string[] | null;
+	/**
+	 * 获取服务供应商对象
+	 * @param {GetProviderObjectOptions} options
+	 * @return {UniProvider | null}
+	 * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.19"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.19"
+	 *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
    *      "unixVer": "x"
    *    }
-   *  },
-   *  "web": {
-   *    "uniVer": "√",
-   *    "unixVer": "4.05"
-   *  }
-   * }
-   * @example
-    ```typescript
-      uni.getProvider({service: ''})
-    ```
-   */
-  getProvider(options: GetProviderOptions) : void;
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	getProviderObject(options : GetProviderObjectOptions) : UniProvider | null;
 }