API Docs for: 2.0.20133.2
Show:

ui.callback.Config Class

Extends ui.UIConfig
Module: UI Callback
Parent Module: UI

Configuration for callback component

Methods

renderComponent

(
  • component
  • config
  • componentType
)
Promise private
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:

Properties

authInfo

ui.AuthInfo
A {{#crossLink "ui.AuthInfo"}}{{/crossLink}} object that specifies the authentication information.

modalities

Array

An array of modality objects (defined in the API Modalities module) returned by the Modalities API

theme

ui.theme.Config
A {{#crossLink "ui.theme.Config"}}{{/crossLink}} provides theme customization for a UI feature(The UI feature MUST support theme customization, otherwise this will be ignored)

uiInfo

UIInfo
A {{#crossLink "ui.UIInfo"}}{{/crossLink}} object that describes how the UI component will be rendered.

Events

onCallbackAccepted

Fired when callback is accepted

onCallbackRejected

Fired when callback is rejected

onError

Fired when an error occurs

Event Payload:

  • data Object
    An object that contains error information
    • message String

      Error message

onSignInRedirect

Fired when popu window redirects to login page

onSignInRequest

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

Fired when the ui component is closed