For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/basic/getSetting.md.

getSetting

获取用户当前的应用授权设置。

扫码预览

扫码预览 getSetting

支持版本

前端库版本不低于 0.0.36。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

使用说明

  • authSetting 只表示当前应用插件的 scope 授权,不表示操作系统权限;HealthKit 逐类型系统状态通过 getAppAuthorizeSetting 查询。
  • authSetting 只包含已向用户请求过且状态明确的权限;豆包当前不支持订阅模板,不要传入 withSubscriptions: true。

调用方式

异步 API

getSetting(params?: GetSettingParams): Promise<GetSettingResult>

入参

名称类型必填默认值约束说明
withSubscriptionsfalse否false豆包 Android、iOS 当前不支持订阅模板,仅支持 false是否同时获取用户订阅消息的订阅状态;当前仅支持 false。

调用示例

import { getSetting } from '@doubao-dev/framework/api';

const result = await getSetting();
console.log(result.authSetting['scope.userLocation']);

成功返回

名称类型必返说明
authSettingAuthSetting是用户授权结果,key 为权限 scope,value 表示是否已授权
subscriptionsSettingSubscriptionsSetting否预留的订阅消息设置字段。豆包当前仅支持 `withSubscriptions: false`,因此不会返回该字段。
subscriptionsSetting.itemSettingsRecord<string, SubscriptionSettingStatus>否一次性订阅消息模板的订阅状态
subscriptionsSetting.mainSwitchboolean否设置页订阅消息总开关
subscriptionsSetting.templateSettingsRecord<string, SubscriptionTemplateSetting>否模板订阅状态

返回示例

{
  "authSetting": {
    "scope.userLocation": true,
    "scope.record": false
  }
}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 103,
  "errMsg": "feature not support"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid、iOS传入 withSubscriptions: true,豆包当前不支持订阅消息模板不要传入 withSubscriptions: true,仅使用默认的 false
116resource not foundAndroid豆包未找到当前应用插件确认当前应用插件已正确安装后重试

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS

平台差异

  • iOS:iOS 不返回 errNo 116(resource not found),相应失败场景统一以 errNo 102(internal error)返回。