Class ViewController

Provides methods to control created paywall view

Hierarchy

  • ViewController

Methods

  • Presents a paywall view as a full-screen modal

    Returns Promise<void>

    Remarks

    Calling present upon already visible paywall view would result in an error

    Throws

  • Creates a set of specific view event listeners

    Parameters

    • Optional eventHandlers: Partial<EventHandlers> = DEFAULT_EVENT_HANDLERS

      set of event handling callbacks

    Returns (() => void)

    unsubscribe - function to unsubscribe all listeners

      • (): void
      • Creates a set of specific view event listeners

        Returns void

        unsubscribe - function to unsubscribe all listeners

        See

        [DOC] Handling View Events

        Remarks

        It registers only requested set of event handlers. Your config is assigned into five event listeners DEFAULT_EVENT_HANDLERS, that handle default behavior.

        • onCloseButtonPress - closes paywall (returns true)
        • onAndroidSystemBack - closes paywall (returns true)
        • onRestoreCompleted - closes paywall (returns true)
        • onPurchaseCompleted - closes paywall on success (returns purchaseResult.type !== 'user_cancelled')
        • onUrlPress - opens URL and keeps paywall open (returns false)

        If you want to override these listeners, we strongly recommend to return the same value as the default implementation from your custom listener to retain default behavior.

    See

    [DOC] Handling View Events

    Remarks

    It registers only requested set of event handlers. Your config is assigned into five event listeners DEFAULT_EVENT_HANDLERS, that handle default behavior.

    • onCloseButtonPress - closes paywall (returns true)
    • onAndroidSystemBack - closes paywall (returns true)
    • onRestoreCompleted - closes paywall (returns true)
    • onPurchaseCompleted - closes paywall on success (returns purchaseResult.type !== 'user_cancelled')
    • onUrlPress - opens URL and keeps paywall open (returns false)

    If you want to override these listeners, we strongly recommend to return the same value as the default implementation from your custom listener to retain default behavior.

Generated using TypeDoc