API Docs for: 2.0.17170.2
Show:

ui.caseManagement.Config Class

Extends ui.UIConfig
Defined in: src\internal\ui\caseManagement\config.ts:10
Module: UI CaseManagement
Parent Module: UI

Configuration for caseManagement component

Properties

authInfo

Object

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\config.ts:28

entitlementId. The entitlement used to submit case

environment

internal.ui.caseManagement.Environment

Defined in src\internal\ui\caseManagement\config.ts:40

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

includedWorkflowSteps

Array

Defined in src\internal\ui\caseManagement\config.ts:46

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

Defined in src\internal\ui\caseManagement\config.ts:16

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

preview

Boolean

Defined in src\internal\ui\caseManagement\config.ts:34

Use compass unpublished data in workflow

sapId

String

Defined in src\internal\ui\caseManagement\config.ts:22

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

theme

Object

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

Object

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\config.ts:53

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

onUnloaded

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

Fired when the ui component is closed