Interface ActivateParamsInput

Describes optional parameters for the activate method.

Hierarchy

  • ActivateParamsInput

Properties

__debugDeferActivation? __ignoreActivationOnFastRefresh? activateUi? android? backendBaseUrl? backendConfigsBaseUrl? backendFallbackBaseUrl? backendProxyHost? backendProxyPort? backendUABaseUrl? 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.

Optional activateUi

activateUi?: boolean

Optional android

android?: {
    adIdCollectionDisabled?: boolean;
}

Type declaration

  • Optional adIdCollectionDisabled?: boolean

    Disables Google AdvertisingID collection

    Default

    false

Optional backendBaseUrl

backendBaseUrl?: string

Optional backendConfigsBaseUrl

backendConfigsBaseUrl?: string

Optional backendFallbackBaseUrl

backendFallbackBaseUrl?: string

Optional backendProxyHost

backendProxyHost?: string

Optional backendProxyPort

backendProxyPort?: number

Optional backendUABaseUrl

backendUABaseUrl?: string

Optional customerUserId

customerUserId?: string

User identifier in your system

Remarks

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

Optional ios

ios?: {
    idfaCollectionDisabled?: boolean;
}

Type declaration

  • Optional idfaCollectionDisabled?: boolean

    Disables IDFA collection

    Default

    false

Optional ipAddressCollectionDisabled

ipAddressCollectionDisabled?: boolean

Disables IP address collection

Default Value

false

Optional lockMethodsUntilReady

lockMethodsUntilReady?: boolean

Locks methods threads until the SDK is ready.

Default Value

false

Deprecated

Turned on by default

Optional logLevel

logLevel?: LogLevel

Log level for the SDK

Remarks

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

Optional mediaCache

mediaCache?: AdaptyUiMediaCache

Optional observerMode

observerMode?: boolean

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

Default Value

false

Optional serverCluster

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc