react-native-adapty - v4.0.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;
        enableMock?: boolean;
        ios?: {
            appAccountToken?: string;
            clearDataOnBackup?: boolean;
            idfaCollectionDisabled?: boolean;
        };
        ipAddressCollectionDisabled?: boolean;
        logLevel?: LogLevel;
        mediaCache?: AdaptyUiMediaCache;
        mockConfig?: AdaptyMockConfig;
        observerMode?: boolean;
        serverCluster?: "default"
        | "eu"
        | "cn";
    }
    Index

    Properties

    __debugDeferActivation? __ignoreActivationOnFastRefresh? activateUi? android? backendProxyHost? backendProxyPort? customerUserId? enableMock? ios? ipAddressCollectionDisabled? logLevel? mediaCache? mockConfig? 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
    • OptionalobfuscatedAccountId?: string
    • OptionalpendingPrepaidPlansEnabled?: boolean
    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
    enableMock?: boolean

    Enables mock mode for web platform

    When enabled, SDK will use mock implementations instead of native modules. Useful for Expo Web and testing.

    false

    ios?: {
        appAccountToken?: string;
        clearDataOnBackup?: boolean;
        idfaCollectionDisabled?: boolean;
    }

    Type Declaration

    • OptionalappAccountToken?: string
    • OptionalclearDataOnBackup?: boolean

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

      false

    • OptionalidfaCollectionDisabled?: boolean

      Disables IDFA collection

      false
    ipAddressCollectionDisabled?: boolean

    Disables IP address collection

    false

    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
    mockConfig?: AdaptyMockConfig

    Configuration for mock mode

    Allows customization of mock data returned by the SDK.

    observerMode?: boolean

    Observer mode. Turn it on when your app handles purchases and subscription status itself (through your own purchase code or a third-party SDK) and uses Adapty only for sending subscription events and analytics.

    This also enables using Adapty Flow (paywall) views in observer mode: the paywall is still rendered by Adapty, but when the user taps buy/restore the SDK does NOT make the purchase — it notifies your app through the onObserverPurchaseInitiated / onObserverRestoreInitiated flow event handlers. Report completed purchases back to Adapty (e.g. via reportTransaction) so they still flow into events and analytics.

    false

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

    Settings

    Member Visibility

    On This Page

    Properties