Redeem Ticket screen class

Redeem Ticket screen class

The Redeem Ticket screen class provides methods associated with the redeem-ticket screen.

Import and instantiate the Redeem Ticket screen class:

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

const redeemTicketManager = new RedeemTicket();

Properties

The Redeem Ticket screen class properties are:

branding

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

Methods

The Redeem Ticket screen class method is:

continue( options ?)

This method continues the flow.

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicket = new RedeemTicket();

// Continue with the default action
await redeemTicket.continue();

Parameter	Type	Required	Description
[key: string]	string | number | boolean | undefined	No	Optional data collected from user.