Class TecsafeWidgetManager

The main entry point for the TECSAFE Widget SDK

Hierarchy (view full)

EventBus
- TecsafeWidgetManager

Constructors

constructor

new TecsafeWidgetManager(customerTokenCallback, addToCartCallback, widgetManagerConfig): TecsafeWidgetManager
The main entry point for the TECSAFE Widget SDK. This class should only be instantiated after the user has consented to the terms, conditions, and privacy policy!
Parameters
- customerTokenCallback: ((oldToken?: string) => Promise<string>)
 A function that returns the customer token as a string inside a promise. It is expected that you implement a route in your backend, using your own auth method, and request a token from our backend, forwarding the oldToken if provided to ensure proper session upgrading.
 - - (oldToken?): Promise<string>
 - Parameters
 OptionaloldToken: string
 Returns Promise<string>
- addToCartCallback: AddToCartHandler
 A function that adds a product to the cart, given the product details, returning a success status.
- widgetManagerConfig: WidgetManagerConfig
 The configuration for the SDK.
Returns TecsafeWidgetManager
Throws
An error if the configuration is invalid.
Overrides EventBus.constructor
- Defined in TecsafeWidgetSDK.ts:37

Properties

`Protected`listeners

listeners: Map<string, MessageEventHandler<any>[]> = ...

Methods

_triggerListeners

_triggerListeners(type, envelope, widget): void
Internal method to trigger listeners from a widget
Parameters
- type: string
- envelope: MessageEnvelope<any>
- widget: BaseWidget
Returns void
- Defined in TecsafeWidgetSDK.ts:201

closeFullScreen

closeFullScreen(): void
Closes the AppWidget full screen mode

Returns void
See
AppWidget
- Defined in TecsafeWidgetSDK.ts:132

createCustomPageWidget

createCustomPageWidget(el): CustomPageWidget
Creates a custom page widget
Parameters
- el: HTMLElement
  The element to attach the widget to
Returns CustomPageWidget
The custom page widget
- Defined in TecsafeWidgetSDK.ts:309

createProductDetailWidget

createProductDetailWidget(el): ProductDetailWidget
Creates a product detail widget
Parameters
- el: HTMLElement
  The element to attach the widget to
Returns ProductDetailWidget
The product detail widget
- Defined in TecsafeWidgetSDK.ts:298

destroyAll

destroyAll(): Promise<void>
Destroys all widgets, and resets the SDK to its initial state

Returns Promise<void>
- Defined in TecsafeWidgetSDK.ts:274

destroyFullScreen

destroyFullScreen(): void
Destroys the AppWidget full screen mode

Returns void
See
AppWidget
- Defined in TecsafeWidgetSDK.ts:141

emit

emit(message, payload): this
Emits a message to all widgets
Type Parameters
- P
Parameters
- message: MessageDefinition
 The message definition
- payload: P
 The payload to send
Returns this
this
- Defined in TecsafeWidgetSDK.ts:215

getAppWidget

getAppWidget(): AppWidget
Gets the app widget

Returns AppWidget
The app widget
- Defined in TecsafeWidgetSDK.ts:319

getBrowserId

getBrowserId(): string
Returns string
- Defined in TecsafeWidgetSDK.ts:113

getConfig

getConfig(): WidgetManagerConfig
Gets the config

Returns WidgetManagerConfig
The config
- Defined in TecsafeWidgetSDK.ts:327

getFullScreenData

getFullScreenData(): any
Gets the full screen data. It is not recommended to use this method directly.

Returns any
The full screen data
- Defined in TecsafeWidgetSDK.ts:359

getMessageListeners

getMessageListeners(): string[]
Gets the list of message types that have listeners registered

Returns string[]
The list of message types
Inherited from EventBus.getMessageListeners
- Defined in util/EventBus.ts:99

getToken

getToken(refresh?): Promise<string>
Gets the token, refreshing it if necessary. Utilizes a cache to prevent multiple requests, and only refreshes the token if it is expired (or refresh is true).
Parameters
- refresh: boolean = false
Returns Promise<string>
The token as a string inside a promise
- Defined in TecsafeWidgetSDK.ts:251

getTokenTimeout

getTokenTimeout(): number
Gets the timestamp (in milliseconds) when the token will expire

Returns number
The timestamp when the token will expire
- Defined in TecsafeWidgetSDK.ts:343

getWidgets

getWidgets(): BaseWidget[]
Gets the widgets

Returns BaseWidget[]
The widgets
- Defined in TecsafeWidgetSDK.ts:335

off

off(message, handler): this
Stops listening to a message from any widget
Type Parameters
- P
Parameters
- message: MessageDefinition
 The message definition
- handler: MessageEventHandler
 The handler to remove
Returns this
this
Overrides EventBus.off
- Defined in TecsafeWidgetSDK.ts:191

on

on(message, handler): this
Listens to a message from any widget
Type Parameters
- P
Parameters
- message: MessageDefinition
 The message definition
- handler: MessageEventHandler
 The handler to call when the message is received
Returns this
this
Overrides EventBus.on
- Defined in TecsafeWidgetSDK.ts:165

once

once(message, handler): this
Listens to a message from any widget once
Type Parameters
- P
Parameters
- message: MessageDefinition
 The message definition
- handler: MessageEventHandler
 The handler to call when the message is received
Returns this
this
Overrides EventBus.once
- Defined in TecsafeWidgetSDK.ts:178

openFullScreen

openFullScreen(url): void
Opens the AppWidget in full screen mode on the provided url
Parameters
- url: string
  The url to open in full screen
Returns void
Throws
An error if the url is not in the allowedOrigins list

See
AppWidget
- Defined in TecsafeWidgetSDK.ts:123

refreshToken

refreshToken(token?): Promise<void>
Refreshes the token and sends it to all widgets
Parameters
- Optionaltoken: string
 If provided, the token to use instead of fetching a new one with the tokenFN
Returns Promise<void>
- Defined in TecsafeWidgetSDK.ts:265

sendToAllWidgets

sendToAllWidgets(message): void
Sends a message to all widgets
Parameters
- message: MessageEnvelope<any>
 The message to send
Returns void
- Defined in TecsafeWidgetSDK.ts:154

setFullScreenData

setFullScreenData(data): void
Sets the full screen data. It is not recommended to use this method directly.
Parameters
- data: any
  The full screen data
Returns void
- Defined in TecsafeWidgetSDK.ts:351

`Protected`trigger

trigger(type, envelope, sdk, widget): void
Triggers all listeners for a given message type
Parameters
- type: string
 The message type
- envelope: MessageEnvelope<any>
 The message envelope containing the payload
- sdk: ISDK
 The SDK instance
- widget: IWidget
 The widget instance
Returns void
Inherited from EventBus.trigger
- Defined in util/EventBus.ts:75

Class TecsafeWidgetManager

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Parameters

Returns Promise<string>

Returns TecsafeWidgetManager

Throws

Properties

Protectedlisteners

Methods

_triggerListeners

Parameters

Returns void

closeFullScreen

Returns void

See

createCustomPageWidget

Parameters

Returns CustomPageWidget

createProductDetailWidget

Parameters

Returns ProductDetailWidget

destroyAll

Returns Promise<void>

destroyFullScreen

Returns void

See

emit

Type Parameters

Parameters

Returns this

getAppWidget

Returns AppWidget

getBrowserId

Returns string

getConfig

Returns WidgetManagerConfig

getFullScreenData

Returns any

getMessageListeners

Returns string[]

getToken

Parameters

Returns Promise<string>

getTokenTimeout

Returns number

getWidgets

Returns BaseWidget[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

openFullScreen

Parameters

Returns void

Throws

See

refreshToken

Parameters

Returns Promise<void>

sendToAllWidgets

Parameters

Returns void

setFullScreenData

Parameters

Returns void

`Protected`listeners

`Protected`trigger