@auth0/auth0-acul-js - v1.10.0
    Preparing search index...

    Interface RedeemTicketMembers

    Interface describing the data available on the Redeem Ticket screen.

    interface RedeemTicketMembers {
        branding: Screens.BrandingMembers;
        client: Screens.ClientMembers;
        countryCodes?: Screens.CountryCodesMembers;
        experiment?: Screens.ExperimentMembers | null;
        organization: Screens.OrganizationMembers;
        prompt: Screens.PromptMembers;
        screen: Screens.ScreenMembers;
        tenant: Screens.TenantMembers;
        transaction: Screens.TransactionMembers;
        untrustedData: Screens.UntrustedDataMembers;
        user: Screens.UserMembers;
        changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>;
        continue(payload?: Screens.CustomOptions): Promise<void>;
        getErrors(): Screens.Error[];
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    branding client countryCodes? experiment? organization prompt screen tenant transaction untrustedData user

    Methods

    changeLanguage continue getErrors

    Properties

    branding: Screens.BrandingMembers
    client: Screens.ClientMembers
    countryCodes?: Screens.CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: Screens.ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: Screens.OrganizationMembers
    prompt: Screens.PromptMembers
    screen: Screens.ScreenMembers
    tenant: Screens.TenantMembers
    transaction: Screens.TransactionMembers
    untrustedData: Screens.UntrustedDataMembers
    user: Screens.UserMembers

    Methods

    • Performs the default action on the redeem-ticket screen, which usually involves continuing the flow.

      Parameters

      Returns Promise<void>

      A promise that resolves when the action is complete.

      If the operation fails.

      import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';

      const redeemTicket = new RedeemTicket();
      await redeemTicket.continue();

    Settings

    Member Visibility

    On This Page

    Properties
    Methods