ElementsConnector

@ticketlayer/live

---

@ticketlayer/live / index / ElementsConnector

Interface: ElementsConnector

Defined in: elements.ts:38

Methods

closeModal()

closeModal(): void;

Defined in: elements.ts:75

Returns

void

---

event()

event(eventId: string): {
  openModal: void;
};

Defined in: elements.ts:73

Parameters

Parameter	Type
eventId	string

Returns

{
  openModal: void;
}

openModal()

openModal(options?: ModalOptions): void;

Parameters

Parameter	Type
options?	ModalOptions

Returns

void

---

getAuthManager()

getAuthManager(): {
  authenticated: boolean;
  customer: unknown;
  exchange: Promise<unknown>;
  logout: Promise<void>;
  requestMagicLink: Promise<unknown>;
};

Defined in: elements.ts:60

Magic-link sign-in (tl-login, tl-my-orders). Never sees a password.

Returns

{
  authenticated: boolean;
  customer: unknown;
  exchange: Promise<unknown>;
  logout: Promise<void>;
  requestMagicLink: Promise<unknown>;
}

authenticated

readonly authenticated: boolean;

customer

readonly customer: unknown;

exchange()

exchange(code: string): Promise<unknown>;

Parameters

Parameter	Type
code	string

Returns

Promise<unknown>

logout()

logout(): Promise<void>;

Returns

Promise<void>

requestMagicLink()

requestMagicLink(contact: {
  email?: string;
  phone?: string;
}): Promise<unknown>;

Parameters

Parameter	Type
contact	{ email?: string; phone?: string; }
contact.email?	string
contact.phone?	string

Returns

Promise<unknown>

---

getCartManager()

getCartManager(): {
  addItem: Promise<unknown>;
  addItems: Promise<unknown>;
  addSeat: Promise<unknown>;
  get: Promise<unknown>;
  off: void;
  on: () => void;
  removeItem: Promise<unknown>;
  removeSeat: Promise<unknown>;
};

Defined in: elements.ts:44

Returns

{
  addItem: Promise<unknown>;
  addItems: Promise<unknown>;
  addSeat: Promise<unknown>;
  get: Promise<unknown>;
  off: void;
  on: () => void;
  removeItem: Promise<unknown>;
  removeSeat: Promise<unknown>;
}

addItem()

addItem(
   ticketTypeId: string, 
   quantity: number, 
occurrenceId: string): Promise<unknown>;

Parameters

Parameter	Type
ticketTypeId	string
quantity	number
occurrenceId	string

Returns

Promise<unknown>

addItems()

addItems(items: {
  occurrenceId: string;
  quantity: number;
  ticketTypeId: string;
}[]): Promise<unknown>;

Parameters

Parameter	Type
items	{ occurrenceId: string; quantity: number; ticketTypeId: string; }[]

Returns

Promise<unknown>

addSeat()

addSeat(
   seatId: string, 
   ticketTypeId: string, 
occurrenceId: string): Promise<unknown>;

Parameters

Parameter	Type
seatId	string
ticketTypeId	string
occurrenceId	string

Returns

Promise<unknown>

get()

get(): Promise<unknown>;

Returns

Promise<unknown>

off()

off(event: string, cb: (data: unknown) => void): void;

Parameters

Parameter	Type
event	string
cb	(data: unknown) => void

Returns

void

on()

on(event: string, cb: (data: unknown) => void): () => void;

Parameters

Parameter	Type
event	string
cb	(data: unknown) => void

Returns

() => void

removeItem()

removeItem(itemId: string): Promise<unknown>;

Parameters

Parameter	Type
itemId	string

Returns

Promise<unknown>

removeSeat()

removeSeat(seatId: string, occurrenceId: string): Promise<unknown>;

Parameters

Parameter	Type
seatId	string
occurrenceId	string

Returns

Promise<unknown>

---

getEventsManager()

getEventsManager(): {
  get: Promise<unknown>;
  getTicketTypes: Promise<unknown[]>;
  list: Promise<{
     items: unknown[];
  }>;
};

Defined in: elements.ts:39

Returns

{
  get: Promise<unknown>;
  getTicketTypes: Promise<unknown[]>;
  list: Promise<{
     items: unknown[];
  }>;
}

get()

get(eventId: string): Promise<unknown>;

Parameters

Parameter	Type
eventId	string

Returns

Promise<unknown>

getTicketTypes()

getTicketTypes(eventId: string, occurrenceId: string): Promise<unknown[]>;

Parameters

Parameter	Type
eventId	string
occurrenceId	string

Returns

Promise<unknown[]>

list()

list(options?: {
  category?: string;
  limit?: number;
}): Promise<{
  items: unknown[];
}>;

Parameters

Parameter	Type
options?	{ category?: string; limit?: number; }
options.category?	string
options.limit?	number

Returns

Promise<{ items: unknown[]; }>

---

getOrdersManager()

getOrdersManager(): {
  get: Promise<unknown>;
  mine: Promise<unknown>;
  ticketPdf: Promise<Blob>;
};

Defined in: elements.ts:54

Returns

{
  get: Promise<unknown>;
  mine: Promise<unknown>;
  ticketPdf: Promise<Blob>;
}

get()

get(orderId: string): Promise<unknown>;

Parameters

Parameter	Type
orderId	string

Returns

Promise<unknown>

mine()

mine(): Promise<unknown>;

Returns

Promise<unknown>

ticketPdf()

ticketPdf(orderId: string, passId: string): Promise<Blob>;

Parameters

Parameter	Type
orderId	string
passId	string

Returns

Promise<Blob>

---

getPresaleManager()

getPresaleManager(): {
  redeem: Promise<PresaleRedemption>;
};

Defined in: elements.ts:68

Presale / promo codes (tl-promo-code).

Returns

{
  redeem: Promise<PresaleRedemption>;
}

redeem()

redeem(code: string): Promise<PresaleRedemption>;

Parameters

Parameter	Type
code	string

Returns

Promise<PresaleRedemption>

---

off()

off(event: string, cb: (data: unknown) => void): void;

Defined in: elements.ts:72

Parameters

Parameter	Type
event	string
cb	(data: unknown) => void

Returns

void

---

on()

on(event: string, cb: (data: unknown) => void): () => void;

Defined in: elements.ts:71

Parameters

Parameter	Type
event	string
cb	(data: unknown) => void

Returns

() => void

Properties

checkout

checkout: {
  closeModal: void;
  openModal: void;
};

Defined in: elements.ts:74

closeModal()

closeModal(): void;

Returns

void

openModal()

openModal(options?: ModalOptions): void;

Parameters

Parameter	Type
options?	ModalOptions

Returns

void