@auth0/auth0-acul-react - v1.9.0
    Preparing search index...

    Interface RedeemTicketMembers

    Interface describing the data available on the Redeem Ticket screen.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    getErrors changeLanguage continue

    Properties

    branding: BrandingMembers
    countryCodes?: 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?: 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.

    tenant: TenantMembers
    user: UserMembers
    untrustedData: UntrustedDataMembers
    client: ClientMembers
    organization: OrganizationMembers
    prompt: PromptMembers
    screen: ScreenMembers
    transaction: TransactionMembers

    Methods

    • Returns Error[]

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

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request.

      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