API Docs for: 2.0.20133.2
Show:

ui.chat.Config Class

Extends ui.UIConfig
Defined in: src\internal\ui\chat\config.ts:9
Module: UI Chat
Parent Module: UI

Configuration for chat 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.

context

Object

Defined in src\internal\ui\chat\config.ts:32

Additional context to pass to the chat agent

modalities

Array

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

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

rejoinUrl

String

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

Url to rejoin a previous chat session

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

onAgentDataReady

Defined in src\internal\ui\chat\config.ts:86

Fired when a chat message is received

Event Payload:

  • data Object

    A data object that is passed through the event

    • AgentId String

      The Id of the Agent

    • DisplayName String

      The name of the Agent

    • ImageUrl String

      A relative url to an image of the Agent

onClosed

Defined in src\internal\ui\chat\config.ts:58

Fired when chat session is closed

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

onEstablished

Defined in src\internal\ui\chat\config.ts:38

Fires when the chat session is established

onMessage

Defined in src\internal\ui\chat\config.ts:64

Fired when a chat message is received

Event Payload:

  • data Object

    A data object that is passed through the event

    • sender Object

      Sender of the message

      • senderName String
        Sender's name

onQueued

Defined in src\internal\ui\chat\config.ts:44

Fires when chat request is queued

onQueueUpdated

Defined in src\internal\ui\chat\config.ts:50

Fires when chat queue status changes

Event Payload:

  • data Object

    A data object that is passed through the event

    • position Number

      Current queue position

onRejoinUrl

Defined in src\internal\ui\chat\config.ts:79

Fired when chat rejoin url is received

Event Payload:

  • data String

    Url to rejoin the chat

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" }]

onTransferred

Defined in src\internal\ui\chat\config.ts:73

Fired when chat is transferred

onUnloaded

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

Fired when the ui component is closed