IframeEventListener.md

@bigcommerce/checkout-sdk / IframeEventListener

Class: IframeEventListener<TEventMap, TContext>

Type parameters

Name	Type
TEventMap	extends IframeEventMap<keyof TEventMap>
TContext	undefined

Table of contents

Constructors

• constructor

Methods

• addListener
• listen
• removeListener
• stopListen
• trigger

Constructors

constructor

• new IframeEventListener<TEventMap, TContext>(sourceOrigin)

Type parameters

Name	Type
TEventMap	extends IframeEventMap<keyof TEventMap>
TContext	undefined

Parameters

Name	Type
sourceOrigin	string

Methods

addListener

▸ addListener<TType>(type, listener): void

Type parameters

Name	Type
TType	extends string | number | symbol

Parameters

Name	Type
type	TType
listener	(event: TEventMap[TType], context?: TContext) => void

Returns

void

---

listen

▸ listen(): void

Returns

void

---

removeListener

▸ removeListener<TType>(type, listener): void

Type parameters

Name	Type
TType	extends string | number | symbol

Parameters

Name	Type
type	TType
listener	(event: TEventMap[TType], context?: TContext) => void

Returns

void

---

stopListen

▸ stopListen(): void

Returns

void

---

trigger

▸ trigger<TType>(event, context?): void

Type parameters

Name	Type
TType	extends string | number | symbol

Parameters

Name	Type
event	TEventMap[TType]
context?	TContext

Returns

void