API Docs for: 2.0.20133.2
Show:

ui.UIConfig Class

Defined in: src\internal\ui\uiConfig.ts:10
Module: UI

Base class that defines common properties & events of a UI component

Methods

renderComponent

(
  • component
  • config
  • componentType
)
Promise private

Defined in src\internal\ui\uiComponent.ts:16

Refer to https://www.typescriptlang.org/docs/handbook/generics.html for usage of Generics in TypeScript Render a UI component with Qos event enabled

Parameters:

  • component TComponent

    Generic type that extends the UIComponent class

  • config TConfig

    Generic type that extends the UIConfig class

  • componentType String

    A string defined by each UI component to represent its type. e.g. "Chat", "Callback", "VirtualAgent", etc ...

Returns:

Promise:

Properties

authInfo

ui.AuthInfo

Defined in src\internal\ui\uiConfig.ts:25

A ui.AuthInfo object that specifies the authentication information.

theme

ui.theme.Config

Defined in src\internal\ui\uiConfig.ts:31

A ui.theme.Config provides theme customization for a UI feature(The UI feature MUST support theme customization, otherwise this will be ignored)

uiInfo

UIInfo

Defined in src\internal\ui\uiConfig.ts:19

A ui.UIInfo object that describes how the UI component will be rendered.

Events

onError

Defined in src\internal\ui\uiConfig.ts:37

Fired when an error occurs

Event Payload:

  • data Object

    An object that contains error information

    • message String

      Error message

onSignInRedirect

Defined in src\internal\ui\uiConfig.ts:52

Fired when popu window redirects to login page

onSignInRequest

Defined in src\internal\ui\uiConfig.ts:45

Fires when user sign-in is requested

Event Payload:

  • data Array

    An array that contains information for supported sign-in types. i.e. [{ type: "MSA", policy: "MBI_SSL" }, { type: "ADD" }]

onUnloaded

Defined in src\internal\ui\uiConfig.ts:58

Fired when the ui component is closed