# Superwall Android SDK

## Docs

- [Superwall](https://superwall.com/docs/android/sdk-reference/Superwall): The shared instance of Superwall that provides access to all SDK features.
- [PurchaseController](https://superwall.com/docs/android/sdk-reference/PurchaseController): An interface for handling Superwall's subscription-related logic with your own purchase implementation.
- [PaywallOptions](https://superwall.com/docs/android/sdk-reference/PaywallOptions): Configuration for paywall presentation and behavior in the Superwall Android SDK.
- [register()](https://superwall.com/docs/android/sdk-reference/register): A function that registers a placement that can be remotely configured to show a paywall and gate feature access.
- [subscriptionStatus](https://superwall.com/docs/android/sdk-reference/subscriptionStatus): A StateFlow property that indicates the subscription status of the user.
- [setSubscriptionStatus()](https://superwall.com/docs/android/sdk-reference/advanced/setSubscriptionStatus): A function that manually sets the subscription status when using a custom PurchaseController.
- [PaywallBuilder](https://superwall.com/docs/android/sdk-reference/advanced/PaywallBuilder): A builder class for creating custom PaywallView instances for advanced presentation.
- [userId](https://superwall.com/docs/android/sdk-reference/userId): A property on Superwall.instance that returns the current user's ID.
- [identify()](https://superwall.com/docs/android/sdk-reference/identify): A function that creates an account with Superwall by linking a userId to the automatically generated alias.
- [SuperwallEvent](https://superwall.com/docs/android/sdk-reference/SuperwallEvent): A sealed class representing analytical events that are automatically tracked by Superwall.
- [getPresentationResult()](https://superwall.com/docs/android/sdk-reference/getPresentationResult): Check the outcome of a placement without presenting a paywall.
- [configure()](https://superwall.com/docs/android/sdk-reference/configure): A static function that configures a shared instance of Superwall for use throughout your app.
- [handleDeepLink()](https://superwall.com/docs/android/sdk-reference/handleDeepLink): A function that handles deep links and triggers paywalls based on configured campaigns.
- [SuperwallDelegate](https://superwall.com/docs/android/sdk-reference/SuperwallDelegate): An interface that handles Superwall lifecycle events and analytics.
- [setUserAttributes()](https://superwall.com/docs/android/sdk-reference/setUserAttributes): A function that sets user attributes for use in paywalls and analytics on the Superwall dashboard.
- [SuperwallOptions](https://superwall.com/docs/android/sdk-reference/SuperwallOptions): A configuration class for customizing paywall appearance and behavior.
- [Overview](https://superwall.com/docs/android/sdk-reference): Reference documentation for the Superwall Android SDK.
- [Tracking Subscription State](https://superwall.com/docs/android/quickstart/tracking-subscription-state): Here's how to view whether or not a user is on a paid plan in Android.
- [Setting User Attributes](https://superwall.com/docs/android/quickstart/setting-user-properties): undefined
- [Presenting Paywalls](https://superwall.com/docs/android/quickstart/feature-gating): Control access to premium features with Superwall placements.
- [Configure the SDK](https://superwall.com/docs/android/quickstart/configure): undefined
- [User Management](https://superwall.com/docs/android/quickstart/user-management): undefined
- [Install the SDK](https://superwall.com/docs/android/quickstart/install): Install the Superwall Android SDK via Gradle.
- [Handling Deep Links](https://superwall.com/docs/android/quickstart/in-app-paywall-previews): undefined
- [Post-Checkout Redirecting](https://superwall.com/docs/android/guides/web-checkout/post-checkout-redirecting): Learn how to handle users redirecting back to your app after a web purchase.
- [Redeeming In-App](https://superwall.com/docs/android/guides/web-checkout/linking-membership-to-iOS-app): Handle a deep link in your app and use the delegate methods.
- [Using RevenueCat](https://superwall.com/docs/android/guides/web-checkout/using-revenuecat): Handle a deep link in your app and use the delegate methods to link web checkouts with RevenueCat.
- [Web Checkout](https://superwall.com/docs/android/guides/web-checkout): Integrate Superwall web checkout with your iOS app for seamless cross-platform subscriptions
- [Migrating from v1 to v2 - Android](https://superwall.com/docs/android/guides/migrations/migrating-to-v2): SuperwallKit 2.0 is a major release of Superwall's Android SDK. This introduces breaking changes.
- [Using the Presentation Handler](https://superwall.com/docs/android/guides/advanced/using-the-presentation-handler): undefined
- [Observer Mode](https://superwall.com/docs/android/guides/advanced/observer-mode): undefined
- [Viewing Purchased Products](https://superwall.com/docs/android/guides/advanced/viewing-purchased-products): undefined
- [Custom Paywall Actions](https://superwall.com/docs/android/guides/advanced/custom-paywall-actions): undefined
- [Device Tier Targeting](https://superwall.com/docs/android/guides/advanced/using-device-tiers-on-android): Target users based on their device performance capabilities to optimize paywall experiences across different hardware tiers.
- [Purchasing Products Outside of a Paywall](https://superwall.com/docs/android/guides/advanced/direct-purchasing): undefined
- [Retrieving and Presenting a Paywall Yourself](https://superwall.com/docs/android/guides/advanced/presenting-paywalls): undefined
- [Game Controller Support](https://superwall.com/docs/android/guides/advanced/game-controller-support): undefined
- [Experimental Flags](https://superwall.com/docs/android/guides/experimental-flags): undefined
- [Advanced Purchasing](https://superwall.com/docs/android/guides/advanced-configuration): If you need fine-grain control over the purchasing pipeline, use a purchase controller to manually handle purchases and subscription status.
- [Cohorting in 3rd Party Tools](https://superwall.com/docs/android/guides/3rd-party-analytics/cohorting-in-3rd-party-tools): To easily view Superwall cohorts in 3rd party tools, we recommend you set user attributes based on the experiments that users are included in. You can also use custom placements for creating analytics events for actions such as interacting with an element on a paywall.
- [Custom Paywall Analytics](https://superwall.com/docs/android/guides/3rd-party-analytics/custom-paywall-analytics): Learn how to log events from paywalls, such as a button tap or product change, to forward to your analytics service.
- [Superwall Events](https://superwall.com/docs/android/guides/3rd-party-analytics/tracking-analytics): The SDK automatically tracks some events, which power the charts in the dashboard. 
- [3rd Party Analytics](https://superwall.com/docs/android/guides/3rd-party-analytics): undefined
- [Advanced Configuration](https://superwall.com/docs/android/guides/configuring): When configuring the SDK you can pass in options that configure Superwall, the paywall presentation, and its appearance.
- [Using the Superwall Delegate](https://superwall.com/docs/android/guides/using-superwall-delegate): undefined
- [Vibe Coding](https://superwall.com/docs/android/guides/vibe-coding): How to Vibe Code using the knowledge of the Superwall Docs
- [Using RevenueCat](https://superwall.com/docs/android/guides/using-revenuecat): undefined
- [Changelog](https://superwall.com/docs/android/changelog): Release notes for the Superwall Android SDK
- [Welcome](https://superwall.com/docs/android): Welcome to the Superwall Android SDK documentation

## Optional

- [GitHub](https://github.com/superwall)
- [Twitter](https://twitter.com/superwall)
- [Blog](https://superwall.com/blog)