Getting Started

安装

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在上游发生变化时，请重新运行同步。

从开始就继续

如果您正在使用 入门 为了计划仪表板和API操作，连接它与 使用@capgo/capacitor-app-tracking-transparency 使用@capgo/capacitor-app-tracking-transparency API概述 API概述 介绍 __CAPGO_KEEP_0__密钥 API密钥 for the implementation detail in API Keys, and 设备 __CAPGO_KEEP_0__细节在Devices中。