API Docs for: 2.0.20133.2
Show:

ui.caseManagement.createCase.CreateCaseConfig Class

Extends ui.caseManagement.CaseConfig
Defined in: src\internal\ui\caseManagement\createCaseConfig.ts:12
Module: UI CaseManagement
Parent Module: UI

Configuration for case management case creation 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.

entitlementId

String

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:25

entitlementId. The entitlement used to submit case

environment

String

Inherited from ui.caseManagement.CaseConfig: src\internal\ui\caseManagement\CaseConfig.ts:27

A value from ui.caseManagement.Environment (default is ui.caseManagement.Environment.PRODUCTION)

hideFormHeaders

Boolean

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:38

Optional flag. If included and set to true default headers for workflow steps will be hidden

includedWorkflowSteps

Array

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:31

Array of step names to include in case creation workflow. When this parameter is omitted or array is empty, all available steps are included

locale

String

Inherited from ui.caseManagement.CaseConfig: src\internal\ui\caseManagement\CaseConfig.ts:15

Locale to render the workflow in, such as en-us, fr-fr

preview

Boolean

Inherited from ui.caseManagement.CaseConfig: src\internal\ui\caseManagement\CaseConfig.ts:21

Use compass unpublished data in workflow

sapId

String

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:19

sapId for associate product and support category with to-be-created case

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)

titlePrePopulate

String

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:50

Optional field. If included and has any key/value pairs, matching form field keys will be prepopulated with value in case creation form

titlePrePopulate

String

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:44

Optional field. If included and has any value, Title will be prepopulated with this value in case creation form

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

onCaseSubmitted

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:56

Fires when the case submission succeeds

Event Payload:

  • data Object

    A data object that is passed through the event

    • caseId Object

      Case id for newly created case if the submission is successful.

    • errorCode Object

      http code for creation request

    • errorMessage Object

      error message for failed request

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

onSubmittingCase

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:66

Fires when submitting case

onUnloaded

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

Fired when the ui component is closed

onWorkflowLoaded

Defined in src\internal\ui\caseManagement\createCaseConfig.ts:72

Fires when workflow loaded