API Docs for: 2.0.20133.2
Show:

ui.assistedSupportPlugin.Config Class

Extends ui.UIConfig
Defined in: src\internal\ui\assistedSupportPlugin\config.ts:9
Module: UI Assisted Support Plugin
Parent Module: UI

Configuration for Assisted Support Plugin component

Methods

renderComponent

(
  • component
  • config
  • componentType
)
Promise private

Inherited from ui.UIConfig: 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

Inherited from ui.UIConfig: src\internal\ui\uiConfig.ts:25

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

issue

String

Defined in src\internal\ui\assistedSupportPlugin\config.ts:39

Assisted Support issue code selected by the user

locale

String

Defined in src\internal\ui\assistedSupportPlugin\config.ts:27

Locale of the experience

pluginUrl

String

Defined in src\internal\ui\assistedSupportPlugin\config.ts:15

Url of the plugin to invoke

product

String

Defined in src\internal\ui\assistedSupportPlugin\config.ts:33

Assisted Support product code selected by the user

puid

String

Defined in src\internal\ui\assistedSupportPlugin\config.ts:21

Puid of the logged in user

theme

ui.theme.Config

Inherited from ui.UIConfig: src\internal\ui\uiConfig.ts:31

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

Inherited from ui.UIConfig: src\internal\ui\uiConfig.ts:19

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

Events

onCancelled

Defined in src\internal\ui\assistedSupportPlugin\config.ts:51

Fired when plugin flow is cancelled by user

onCompleted

Defined in src\internal\ui\assistedSupportPlugin\config.ts:45

Fired when plugin flow is completed by user

onError

Inherited from ui.UIConfig: 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

Inherited from ui.UIConfig: src\internal\ui\uiConfig.ts:52

Fired when popu window redirects to login page

onSignInRequest

Inherited from ui.UIConfig: 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

Inherited from ui.UIConfig: src\internal\ui\uiConfig.ts:58

Fired when the ui component is closed