@adapty/capacitor - v3.16.1
    Preparing search index...

    Interface ActivateParamsInput

    Describes optional parameters for the activate method.

    interface ActivateParamsInput {
        __debugDeferActivation?: boolean;
        __ignoreActivationOnFastRefresh?: boolean;
        activateUi?: boolean;
        android?: {
            adIdCollectionDisabled?: boolean;
            localAccessLevelAllowed?: boolean;
            obfuscatedAccountId?: string;
            pendingPrepaidPlansEnabled?: boolean;
        };
        backendProxyHost?: string;
        backendProxyPort?: number;
        customerUserId?: string;
        ios?: {
            appAccountToken?: string;
            clearDataOnBackup?: boolean;
            idfaCollectionDisabled?: boolean;
        };
        ipAddressCollectionDisabled?: boolean;
        lockMethodsUntilReady?: boolean;
        logLevel?: LogLevel;
        mediaCache?: AdaptyUiMediaCache;
        observerMode?: boolean;
        serverCluster?: "default"
        | "eu"
        | "cn";
    }
    Index

    Properties

    __debugDeferActivation? __ignoreActivationOnFastRefresh? activateUi? android? backendProxyHost? backendProxyPort? customerUserId? ios? ipAddressCollectionDisabled? lockMethodsUntilReady? logLevel? mediaCache? observerMode? serverCluster?

    Properties

    Optional__debugDeferActivation

    __debugDeferActivation?: boolean

    Does not activate SDK until any other method is called Fixes annoying iOS simulator auhtentication

    Optional__ignoreActivationOnFastRefresh

    __ignoreActivationOnFastRefresh?: boolean

    Ignores multiple activation attempts on fast refresh. If true, skips activation if SDK is already activated.

    activateUi?: boolean
    android?: {
        adIdCollectionDisabled?: boolean;
        localAccessLevelAllowed?: boolean;
        obfuscatedAccountId?: string;
        pendingPrepaidPlansEnabled?: boolean;
    }

    Type Declaration

    • OptionaladIdCollectionDisabled?: boolean

      Disables Google AdvertisingID collection

      false
    • OptionallocalAccessLevelAllowed?: boolean

      Allows using local access level data on Android when available

      android

      false
    • OptionalobfuscatedAccountId?: string

      Obfuscated account ID

      android

    • OptionalpendingPrepaidPlansEnabled?: boolean

      Enable pending prepaid plans for Android

      android

      false
    backendProxyHost?: string
    backendProxyPort?: number
    customerUserId?: string

    User identifier in your system

    If none of the parameters are passed, the SDK will generate an ID and use it for a current device. Use your own ID:

    1. If you want to support a cross-device experience
    2. If you have your own authentication system, and you want to associate adapty profile with your user
    ios?: {
        appAccountToken?: string;
        clearDataOnBackup?: boolean;
        idfaCollectionDisabled?: boolean;
    }

    Type Declaration

    • OptionalappAccountToken?: string

      App account token for iOS

      ios

    • OptionalclearDataOnBackup?: boolean

      Controls whether the SDK will create a new profile when the app is restored from an iCloud backup

      false

      ios

    • OptionalidfaCollectionDisabled?: boolean

      Disables IDFA collection

      false
    ipAddressCollectionDisabled?: boolean

    Disables IP address collection

    false

    lockMethodsUntilReady?: boolean

    Locks methods threads until the SDK is ready.

    false

    Turned on by default

    logLevel?: LogLevel

    Log level for the SDK

    Logging is performed on a native side. So you are expected to watch logs in Xcode or Android Studio.

    mediaCache?: AdaptyUiMediaCache
    observerMode?: boolean

    Turn it on if you handle purchases and subscription status yourself and use Adapty for sending subscription events and analytics

    false

    serverCluster?: "default" | "eu" | "cn"

    Settings

    Member Visibility

    On This Page

    Properties