tt.openSetting
收藏我的收藏
收藏基础库 1.3.0 开始支持本方法，这是一个异步方法。
打开设置页面,返回用户设置过的授权结果。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.openSetting(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| withSubscriptions | boolean | false | 否 | 是否同时获取用户订阅消息的订阅状态，默认不获取。 | 2.69.0 |
| success | function | 否 | 接口调用成功的回调函数 | 1.3.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.3.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.3.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "openSetting:ok" | 1.0.0 |
| authSetting | object | 授权结果 AuthSetting | 1.3.0 |
| subscriptionsSetting | object | 订阅消息设置，接口参数withSubscriptions值为true时才会返回。 返回所有用户在弹窗中勾选了并点击同意或拒绝的模板订阅状态。 | 2.69.0 |
subscriptionsSetting 参数说明
返回所有询问过的一次性模板和长期模板的模板 id。
属性名 | 说明 | 最低支持版本 |
mainSwitch | 设置页订阅消息开关，true为开启，false为关闭 | 2.69.0 |
templateSettings | 订阅结果 | 3.35.0 |
templateSettings
object 类型，key 为模板 id，value 为 object 类型，属性如下：
属性名 | 类型 | 说明 |
status | string | 订阅结果 |
alwaysSubscribe | bool | 是否为长期订阅状态(长期订阅状态的模板后续不会弹窗询问用户)。 |
allowReminderWay | ReminderWay[] | 返回模板支持的提醒方式对应的用户授权结果。 |
status 枚举如下：
值 | 描述 |
accept | 用户同意订阅该条 id 对应的模板消息。 |
reject | 用户拒绝订阅该条 id 对应的模板消息。 |
RemindWay
object 类型，属性如下：
属性名 | 类型 | 说明 |
reminderType | string | 提醒方式。 |
reminderStatus | string | 提醒授权结果。 |
reminderType 枚举值如下：
值 | 描述 |
message_notice | 消息通知。默认支持 |
feed | 推荐频道提醒。开发者需要申请支持信息流通知的模板。 |
push | 实时提醒。开发者需要申请支持实时提醒的模板。 |
reminderStatus 枚举值如下：
值 | 描述 |
reject | 拒绝 |
accept | 同意 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "openSetting:fail" + 详细错误信息 | 1.3.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 115191 | openSetting:fail Internal error: no api callback | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.3.0 |
扫码体验
请使用字节宿主APP扫码
