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/open/business/getPrivacySetting.md.

getPrivacySetting

获取隐私设置状态。

扫码预览

扫码预览 getPrivacySetting

支持版本

前端库版本不低于 0.0.19。

支持平台

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

支持场景

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

使用说明

  • 用于在展示隐私相关能力前判断是否需要引导用户完成隐私协议授权。

调用方式

异步 API

getPrivacySetting(params?: object): Promise<PrivacySettingResult>

入参

无。

调用示例

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

const { needAuthorization } = await getPrivacySetting();

console.log(needAuthorization);

成功返回

名称类型必返说明
needAuthorizationboolean是是否需要用户对隐私协议进行授权。

返回示例

{
  "needAuthorization": false
}

错误处理

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

错误码

通用错误码

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

平台差异

  • 该 API 无专属错误码,失败时统一返回 102。