Interface PaywallInteractionEvent

A paywall control interaction, as passed to PaywallListener.onInteraction. Keys that do not apply are omitted.

See https://rev.cat/paywall-interaction-events for what each component type sends.

interface PaywallInteractionEvent {
    component_name?: string;
    component_type: string;
    component_url?: string;
    component_value: string;
    current_package_id?: string;
    current_product_id?: string;
    dark_mode?: boolean;
    default_index?: number;
    default_package_id?: string;
    default_product_id?: string;
    destination_context_name?: string;
    destination_index?: number;
    destination_package_id?: string;
    destination_product_id?: string;
    display_mode?: string;
    locale?: string;
    offering_id: string;
    origin_context_name?: string;
    origin_index?: number;
    origin_package_id?: string;
    origin_product_id?: string;
    paywall_id?: string;
    paywall_revision: number;
    resulting_package_id?: string;
    resulting_product_id?: string;
    session_id: string;
    timestamp: number;
}

Properties

component_name? component_type component_url? component_value current_package_id? current_product_id? dark_mode? default_index? default_package_id? default_product_id? destination_context_name? destination_index? destination_package_id? destination_product_id? display_mode? locale? offering_id origin_context_name? origin_index? origin_package_id? origin_product_id? paywall_id? paywall_revision resulting_package_id? resulting_product_id? session_id timestamp

Properties

Optional Readonlycomponent_name

component_name?: string

Readonlycomponent_type

component_type: string

Optional Readonlycomponent_url

component_url?: string

Readonlycomponent_value

component_value: string

Optional Readonlycurrent_package_id

current_package_id?: string

Optional Readonlycurrent_product_id

current_product_id?: string

Optional Readonlydark_mode

dark_mode?: boolean

Optional Readonlydefault_index

default_index?: number

Optional Readonlydefault_package_id

default_package_id?: string

Optional Readonlydefault_product_id

default_product_id?: string

Optional Readonlydestination_context_name

destination_context_name?: string

Optional Readonlydestination_index

destination_index?: number

Optional Readonlydestination_package_id

destination_package_id?: string

Optional Readonlydestination_product_id

destination_product_id?: string

Optional Readonlydisplay_mode

display_mode?: string

Optional Readonlylocale

locale?: string

Readonlyoffering_id

offering_id: string

Optional Readonlyorigin_context_name

origin_context_name?: string

Optional Readonlyorigin_index

origin_index?: number

Optional Readonlyorigin_package_id

origin_package_id?: string

Optional Readonlyorigin_product_id

origin_product_id?: string

Optional Readonlypaywall_id

paywall_id?: string

Readonlypaywall_revision

paywall_revision: number

Optional Readonlyresulting_package_id

resulting_package_id?: string

Optional Readonlyresulting_product_id

resulting_product_id?: string

Readonlysession_id

session_id: string

Readonlytimestamp

timestamp: number

Settings

Member Visibility

On This Page

Properties