Non Productive Monday

    capacitor-plugin-app-tracking-transparency
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    capacitor-plugin-app-tracking-transparency

    Capacitor plugin to request user authorization to access app-related data for tracking the user or the device. iOS only.

    Read more about Apple's App Tracking Transparency framework here. Also this might be a good read.

    Platform support

    iOS only but with web fallback for development purposes.

    Plugin versions

    Capacitor version Plugin version
    >= 3.0.0 2.x.x
    < 3.0.0 1.x.x

    For plugin version 1.x.x docs please refer to branch v1.

    Maintainers

    Maintainer GitHub Social
    Manuel Heidrich mahnuh @mahnuh
    prototype.berlin GmbH prototype-berlin @prototypeberlin

    Install

    npm install capacitor-plugin-app-tracking-transparency
    npx cap sync

    Configuration

    Add this to your app's Info.plist and update the message according to your needs:

    <key>NSUserTrackingUsageDescription</key>
    <string>Your data will be used to deliver personalized ads to you.</string>

    This message can be provided in multiple languages by using a InfoPlist.strings file. See the Apple docs or this stack overflow answer for help.

    Usage

    import 'capacitor-plugin-app-tracking-transparency'; // only if you want web support
    
    import {
      AppTrackingTransparency,
      AppTrackingStatusResponse,
    } from 'capacitor-plugin-app-tracking-transparency';
    
    ...
    
    public async getStatus(): Promise<AppTrackingStatusResponse> {
      const response = await AppTrackingTransparency.getStatus();
    
      console.log(response);
      // { status: 'authorized' } for example
    
      return response;
    }
    
    public async requestPermission(): Promise<AppTrackingStatusResponse> {
      const response = await AppTrackingTransparency.requestPermission();
    
      console.log(response);
      // { status: 'authorized' } for example
    
      return response;
    }

    Both available methods return AppTrackingStatusResponse with status: AppTrackingStatus, which will be one of the following: authorized, denied, notDetermined or restricted. See Apple's docs for reference.

    API

    getStatus()

    getStatus() => any

    Returns: any


    requestPermission()

    requestPermission() => any

    Returns: any


    Todos

    • [ ] Extend API docs

    License

    MIT

    Install

    npm i capacitor-plugin-app-tracking-transparency

    DownloadsWeekly Downloads

    4,485

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    19.1 kB

    Total Files

    23

    Last publish

    Collaborators

    • mahnuh