前言
以下API,小程序业务方需要申请权限:参考https://www.yuque.com/hanling-irfir/swm2yg/itnrv2
覆盖 API 列表
showAuthGuide 接口
定位授权弹窗(仅Android需要使用, iOS不需要)
Android端优酷app本身没有定位权限。因此小程序如果需要定位权限,需要调用JSAPI my.showAuthGuide替优酷app向系统申请权限。
使用详见官方文档:https://opendocs.alipay.com/mini/api/show-auth-guide
入参**
名称 | 类型 | 描述 | 必选 | 默认值 | 备注 |
---|---|---|---|---|---|
authType | String | 权限类型 | Y | 无 | 必须传”LBS” |
出参**
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
code | Integer | 申请结果 | 0表示申请权限成功 -1表示申请权限失败 |
使用方法**
my.showAuthGuide({
bizType: "xxx",
authType: "LBS",
success: res => {
logger.info(`showAuthGuide success: ${JSON.stringify(res)}, `);
//shown为true时表示会显示权限引导弹窗,为false时表示用户已经授权
let { code } = res;
code = code.toString();
},
fail: error => {
logger.error(`showAuthGuide: ${JSON.stringify(error)}`);
}
});
扩展 API 列表
my.yk.getYouKuUserInfo(即将废弃,使用my.yk.openCallOnYouku)
(效果同 ~~[https://opendocs.alipay.com/mini/api/openapi-authorize~~](https://opendocs.alipay.com/mini/api/openapi-authorize)~~ 优酷侧可用)说明:获取优酷用户信息,包括uid、yid、userName等~~
入参 | 类型 | 默认值 | 解释 |
---|---|---|---|
needEcodeSign | BOOL | false | 为YES时,没登录的情况下会拉取优酷登录窗 |
出参 | 类型 | 默认值 | 解释 |
---|---|---|---|
isLogin | BOOL | false | 是否登录,登录为YES |
youkuUid | String | “” | 优酷用户id |
uid | String | “” | 优酷土豆唯一id |
yid | String | “” | 优酷id |
avatarUrl | String | “” | 头像 |
userName | String | “” | 用户名 |
nickName | String | “” | 昵称 |
my.yk.openCallOnYouku(0811以后上线使用)
说明:获取优酷用户信息,包括uid、yid、userName等
my.call('openCallOnYouku', {
function: 'getYouKuUserInfo',
params: {
needEcodeSign: true,
},
}, (result) => {
console.log(JSON.stringify(result));
});
入参 | 类型 | 默认值 | 解释 |
---|---|---|---|
needEcodeSign | BOOL | false | 为YES时,没登录的情况下会拉取优酷登录窗 |
出参 | 类型 | 默认值 | 解释 |
---|---|---|---|
isLogin | BOOL | false | 是否登录,登录为YES |
youkuUid | String | “” | 优酷用户id |
uid | String | “” | 优酷土豆唯一id |
yid | String | “” | 优酷id |
avatarUrl | String | “” | 头像 |
userName | String | “” | 用户名 |
nickName | String | “” | 昵称 |
- 小程序预加载能力
my.call('openCallOnYouku', {
function: 'preloadMiniApp',
params: {
url: 'youku://miniapp/preloadMiniApp?appId=3000000005573371&_mp_code=tb',
},
}, (result) => {
console.log(JSON.stringify(result));
});
入参 | 类型 | 默认值 | 解释 |
---|---|---|---|
url | String | 预加载路由 |
my.yk.getYouKuConfig
暗黑模式等信息获取, 接受type参数,返回对应的结果。如果不传type,返回全部结果
入参 | 类型 | 默认值 | 解释 |
---|---|---|---|
type | String | 空 | 接受type参数,返回对应的结果。如果不传type,返回全部结果 |
入参不同对应不同的返回结果:
type | 出参 | 类型 | 默认值 | 解释 |
---|---|---|---|---|
DarkMode | currentThemeID | String | 无 | 暗黑模式值 |
ColorToken | colorTokenTable | String | 无 | 暗黑模式Design Toke |
RequestParam | gray | String | 无 | 灰度信息 |
ver | String | 无 | 优酷版本 | |
pid | String | 无 | Profile.Wireless_pid | |
deviceId | String | 无 | 就是utdid | |
guid | String | 无 | ||
appPackage | String | 无 | 包名 |
my.yk.navigateToYoukuPage
优酷内部路由跳转
入参
名称 | 类型 | 描述 | 必选 | 默认值 | 备注 |
---|---|---|---|---|---|
url | String | 跳转schema | Y | 无 | 支持Nav跳转 |
出参
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
status | String | 跳转状态 | fail:表示传入参数url非法 success:表示传入参数url正常 |