开始使用

安装

bun add @capgo/capacitor-app-tracking-transparency
bunx cap sync

导入

import { AppTrackingTransparency } from '@capgo/capacitor-app-tracking-transparency';

API概述

getStatus

获取当前跟踪授权状态，无需提示用户。

import { AppTrackingTransparency } from '@capgo/capacitor-app-tracking-transparency';

const { status } = await AppTrackingTransparency.getStatus();
if (status === 'authorized') {
  console.log('Tracking is authorized');
}

requestPermission

请求用户授权访问应用程序相关数据以进行跟踪。 显示原生iOS跟踪权限对话框。

注意：此方法只会显示对话框一次。后续调用将返回存储的授权状态而不显示对话框。

import { AppTrackingTransparency } from '@capgo/capacitor-app-tracking-transparency';

const { status } = await AppTrackingTransparency.requestPermission();
switch (status) {
  case 'authorized':
    console.log('User authorized tracking');
    break;
  case 'denied':
    console.log('User denied tracking');
    break;
  case 'restricted':
    console.log('Tracking is restricted');
    break;
  case 'notDetermined':
    console.log('Status not determined');
    break;
}

类型参考

AppTrackingStatusResponse

包含跟踪授权状态的响应对象。

export interface AppTrackingStatusResponse {
  /**
   * The current tracking authorization status.
   *
   * @since 1.0.0
   */
  status: AppTrackingStatus;
}

AppTrackingStatus

跟踪授权状态的可能值。

export type AppTrackingStatus = 'authorized' | 'denied' | 'notDetermined' | 'restricted';

真实来源

此页面由插件生成 src/definitions.ts当公共API上游发生变化时，请重新运行同步。