@dcloudio/uni-app-x 0.7.19 → 0.7.21

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

@@ -1,375 +1,375 @@
-export type GetProviderSuccess = {
-	/**
-	 * 服务类型
-	 * - payment: 支付
-	 * - location: 定位
-	 * @type 'payment'
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	service : 'payment' | 'location',
-	/**
-	 * 得到的服务供应商
-	 * @type PlusShareShareService['id'][] | PlusPushClientInfo['id'][] | PlusOauthAuthService['id'][] | PlusPaymentPaymentChannel['id'][]
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	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[],
-	/**
-	 * 错误信息
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	errMsg : string
-};
-export type GetProviderSuccessCallback = (result : GetProviderSuccess) => void;
-export type GetProviderFail = UniError;
-export type GetProviderFailCallback = (result : GetProviderFail) => void;
-export type GetProviderComplete = any;
-export type GetProviderCompleteCallback = (result : GetProviderComplete) => void;
-export type GetProviderOptions = {
-	/**
-	 * 服务类型，可取值“payment”、“location”
-	 * - payment: 支付 (Alipay、Wxpay)
-	 * - location: 定位 (System、Tencent)
-	 * @type 'payment' | 'location''
-	 * @type 'payment'
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	service : 'payment' | 'location',
-	/**
-	 * 接口调用成功的回调
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	success ?: GetProviderSuccessCallback | null,
-	/**
-	 * 接口调用失败的回调函数
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	fail ?: GetProviderFailCallback | null,
-	/**
-	 * 接口调用结束的回调函数（调用成功、失败都会执行）
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.18"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	*/
-	complete ?: GetProviderCompleteCallback | null
-};
-
-export type GetProvider = (options : GetProviderOptions) => void;
-
-export type GetProviderIds = (options : GetProviderIdsOptions) => string[] | null;
-
-export type GetProviderObject = (options : GetProviderObjectOptions) => UniProvider | null;
-
-export type GetProviderIdsOptions = {
-	/**
-	 * 服务类型，可取值“payment”、“location”
-	 * - payment: 支付 (Alipay、Wxpay)
-	 * - location: 定位 (System、Tencent)
-	 * @type 'payment' | 'location''
-	 * @type 'payment'
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	service : 'payment' | 'location',
-};
-
-export type GetProviderObjectOptions = {
-	/**
-	 * 服务类型，可取值“payment”、“location”
-	 * - payment: 支付 (Alipay、Wxpay)
-	 * - location: 定位 (System、Tencent)
-	 * @type 'payment' | 'location''
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	service : 'payment' | 'location',
-
-	/**
-	 * 服务供应商
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	provider : string
-};
-
-export interface Uni {
-	/**
-	 * 获取服务供应商
-	 * @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.23",
-	 *      "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.25"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    },
-   *    "harmony": {
-   *      "osVer": "x",
-   *      "uniVer": "x",
-   *      "unixVer": "x"
-   *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	getProviderIds(options : GetProviderIdsOptions) : string[] | null;
-	/**
-	 * 获取服务供应商对象
-	 * @param {GetProviderObjectOptions} options
-	 * @return {UniProvider | null} provider对象
-	 * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html
-	 * @uniPlatform {
-	 *  "app": {
-	 *    "android": {
-	 *      "osVer": "5.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    },
-	 *    "ios": {
-	 *      "osVer": "9.0",
-	 *      "uniVer": "√",
-	 *      "unixVer": "4.25"
-	 *    },
-   *    "harmony": {
-   *      "osVer": "x",
-   *      "uniVer": "x",
-   *      "unixVer": "x"
-   *    }
-	 *  },
-	 *  "web": {
-	 *    "uniVer": "x",
-	 *    "unixVer": "x"
-	 *  }
-	 * }
-	 */
-	getProviderObject(options : GetProviderObjectOptions) : UniProvider | null;
-}
+export type GetProviderSuccess = {
+	/**
+	 * 服务类型
+	 * - payment: 支付
+	 * - location: 定位
+	 * @type 'payment'
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	service : 'payment' | 'location',
+	/**
+	 * 得到的服务供应商
+	 * @deprecated 从4.25版本后已弃用，请使用providerIds 代替
+	 * @type PlusShareShareService['id'][] | PlusPushClientInfo['id'][] | PlusOauthAuthService['id'][] | PlusPaymentPaymentChannel['id'][]
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	provider : string[],
+	/**
+	 * 得到的服务供应商
+	 * @type PlusShareShareService['id'][] | PlusPushClientInfo['id'][] | PlusOauthAuthService['id'][] | PlusPaymentPaymentChannel['id'][]
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	providerIds : string[],
+	/**
+	 * 得到的服务供应商服务对象
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	providerObjects : UniProvider[]
+	/**
+	 * 得到的服务供应商服务对象
+	 * @deprecated 从4.25版本后已弃用，请使用providerObjects 代替
+	 * @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[]
+
+};
+export type GetProviderSuccessCallback = (result : GetProviderSuccess) => void;
+export type GetProviderFail = UniError;
+export type GetProviderFailCallback = (result : GetProviderFail) => void;
+export type GetProviderComplete = any;
+export type GetProviderCompleteCallback = (result : GetProviderComplete) => void;
+export type GetProviderOptions = {
+	/**
+	 * 服务类型，可取值“payment”、“location”
+	 * - payment: 支付 (alipay、wxpay)
+	 * - location: 定位 (system、tencent)
+	 * @type 'payment' | 'location''
+	 * @type 'payment'
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	service : 'payment' | 'location',
+	/**
+	 * 接口调用成功的回调
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	success ?: GetProviderSuccessCallback | null,
+	/**
+	 * 接口调用失败的回调函数
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	fail ?: GetProviderFailCallback | null,
+	/**
+	 * 接口调用结束的回调函数（调用成功、失败都会执行）
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.18"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	*/
+	complete ?: GetProviderCompleteCallback | null
+};
+
+export type GetProvider = (options : GetProviderOptions) => void;
+
+export type GetProviderSync = (options : GetProviderOptions) => GetProviderSuccess;
+
+export type GetProviderObjectById = (options : GetProviderObjectByIdOptions) => UniProvider | null;
+
+export type GetProviderObjectByIdOptions = {
+	/**
+	 * 服务类型，可取值“payment”、“location”
+	 * - payment: 支付 (alipay、wxpay)
+	 * - location: 定位 (system、tencent)
+	 * @type 'payment' | 'location''
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	service : 'payment' | 'location',
+
+	/**
+	 * 服务供应商
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	provider : string
+};
+
+export interface Uni {
+	/**
+	 * 获取服务供应商
+	 * @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.23",
+	 *      "unixVer": "x"
+	 *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	getProvider(options : GetProviderOptions) : void;
+	/**
+	 * 获取服务供应商 getProvider 的同步方法
+	 * @deprecated 已废弃（仅为了兼容uni1的规范）
+	 *
+	 * @param {GetProviderOptions} options
+	 * @return {GetProviderSuccess} 返回结果
+	 * @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.25"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	getProviderSync(options : GetProviderOptions) : GetProviderSuccess;
+	/**
+	 * 获取服务供应商对象
+	 * @param {GetProviderObjectOptions} options
+	 * @return {UniProvider | null} provider对象
+	 * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html
+	 * @uniPlatform {
+	 *  "app": {
+	 *    "android": {
+	 *      "osVer": "5.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+	 *    "ios": {
+	 *      "osVer": "9.0",
+	 *      "uniVer": "√",
+	 *      "unixVer": "4.25"
+	 *    },
+   *    "harmony": {
+   *      "osVer": "x",
+   *      "uniVer": "x",
+   *      "unixVer": "x"
+   *    }
+	 *  },
+	 *  "web": {
+	 *    "uniVer": "x",
+	 *    "unixVer": "x"
+	 *  }
+	 * }
+	 */
+	getProviderObjectById(options : GetProviderObjectByIdOptions) : UniProvider | null;
+}