@adapty/capacitor - v4.1.3
    Preparing search index...

    Interface AdaptyPlugin

    interface AdaptyPlugin {
        addListener: AddListenerFn;
        activate(
            options: { apiKey: string; params?: ActivateParamsInput },
        ): Promise<void>;
        createWebPaywallUrl(
            options: { paywallOrProduct: AdaptyFlowPaywall | AdaptyPaywallProduct },
        ): Promise<string>;
        getCurrentInstallationStatus(): Promise<AdaptyInstallationStatus>;
        getFlow(
            options: { params?: GetPlacementParamsInput; placementId: string },
        ): Promise<AdaptyFlow>;
        getFlowForDefaultAudience(
            options: {
                params?: GetPlacementForDefaultAudienceParamsInput;
                placementId: string;
            },
        ): Promise<AdaptyFlow>;
        getOnboarding(
            options: {
                locale?: string;
                params?: GetPlacementParamsInput;
                placementId: string;
            },
        ): Promise<AdaptyOnboarding>;
        getOnboardingForDefaultAudience(
            options: {
                locale?: string;
                params?: GetPlacementForDefaultAudienceParamsInput;
                placementId: string;
            },
        ): Promise<AdaptyOnboarding>;
        getPaywallProducts(
            options: { flow: AdaptyFlow },
        ): Promise<AdaptyPaywallProduct[]>;
        getProfile(): Promise<AdaptyProfile>;
        identify(
            options: { customerUserId: string; params?: IdentifyParamsInput },
        ): Promise<void>;
        isActivated(): Promise<boolean>;
        logout(): Promise<void>;
        logShowFlow(options: { flow: AdaptyFlow }): Promise<void>;
        makePromotedPurchase(
            options: { product: AdaptyPromotedProduct },
        ): Promise<AdaptyPurchaseResult>;
        makePurchase(
            options: {
                params?: MakePurchaseParamsInput;
                product: AdaptyPaywallProduct;
            },
        ): Promise<AdaptyPurchaseResult>;
        openWebPaywall(
            options: {
                openIn?: WebPresentation;
                paywallOrProduct: AdaptyFlowPaywall | AdaptyPaywallProduct;
            },
        ): Promise<void>;
        openWebUrl(
            options: { openIn?: WebPresentation; url: string },
        ): Promise<void>;
        presentCodeRedemptionSheet(): Promise<void>;
        removeAllListeners(): Promise<void>;
        reportTransaction(
            options: { transactionId: string; variationId?: string },
        ): Promise<void>;
        requestAppReview(): Promise<void>;
        restorePurchases(): Promise<AdaptyProfile>;
        setFallback(options: { fileLocation: FileLocation }): Promise<void>;
        setIntegrationIdentifier(
            options: { key: string; value: string },
        ): Promise<void>;
        setLogLevel(
            options: { logger?: LoggerConfig; logLevel?: LogLevel },
        ): Promise<void>;
        updateCollectingRefundDataConsent(
            options: { consent: boolean },
        ): Promise<void>;
        updateExternalAttribution(
            options: {
                attribution: Record<string, any>;
                provider: AdaptyExternalAttributionProvider;
            },
        ): Promise<void>;
        updateProfile(options: Partial<AdaptyProfileParameters>): Promise<void>;
        updateRefundPreference(
            options: { refundPreference: RefundPreference },
        ): Promise<void>;
    }

    Implemented by

    Index

    Properties

    addListener

    Methods

    activate createWebPaywallUrl getCurrentInstallationStatus getFlow getFlowForDefaultAudience getOnboarding getOnboardingForDefaultAudience getPaywallProducts getProfile identify isActivated logout logShowFlow makePromotedPurchase makePurchase openWebPaywall openWebUrl presentCodeRedemptionSheet removeAllListeners reportTransaction requestAppReview restorePurchases setFallback setIntegrationIdentifier setLogLevel updateCollectingRefundDataConsent updateExternalAttribution updateProfile updateRefundPreference

    Properties

    addListener: AddListenerFn

    Adds a strongly-typed event listener.

    Supported events:

    • onLatestProfileLoad → { profile: AdaptyProfile }
    • onPromotedPurchaseReceived → { product: AdaptyPromotedProduct }
    • onInstallationDetailsSuccess → { details: AdaptyInstallationDetails }
    • onInstallationDetailsFail → { error: AdaptyError }

    Registering a listener for 'onPromotedPurchaseReceived' replaces the SDK's default behaviour, which is to complete the purchase automatically. While a listener is registered you are responsible for completing the purchase — call AdaptyPlugin.makePromotedPurchase with the product you receive, or the purchase never happens. Removing the returned handle restores the default.

    Methods

    • Presents the code redemption sheet (iOS only).

      Returns Promise<void>

    • Reports a transaction to Adapty.

      Parameters

      • options: { transactionId: string; variationId?: string }

      Returns Promise<void>

    • Sets an integration identifier.

      Parameters

      • options: { key: string; value: string }

      Returns Promise<void>

    • Updates collecting refund data consent (iOS only).

      Parameters

      • options: { consent: boolean }

      Returns Promise<void>

    • Updates attribution data from an external attribution provider for the current user.

      Parameters

      • options: {
            attribution: Record<string, any>;
            provider: AdaptyExternalAttributionProvider;
        }

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods