ui.caseManagement.createCase.CreateCaseConfig Class
Configuration for case management case creation component
Item Index
Methods
Properties
Methods
renderComponent
(
Promise
private
-
component
-
config
-
componentType
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
TComponentGeneric type that extends the UIComponent class -
config
TConfigGeneric type that extends the UIConfig class -
componentType
StringA 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.
environment
String
A value from ui.caseManagement.Environment (default is ui.caseManagement.Environment.PRODUCTION)
hideFormHeaders
Boolean
Optional flag. If included and set to true default headers for workflow steps will be hidden
includedWorkflowSteps
ArrayArray of step names to include in case creation workflow. When this parameter is omitted or array is empty, all available steps are included
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)
titlePrePopulate
String
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
Optional field. If included and has any value, Title will be prepopulated with this value in case creation form
uiInfo
UIInfo
A {{#crossLink "ui.UIInfo"}}{{/crossLink}} object that describes how the UI component will be rendered.
Events
onCaseSubmitted
Fires when the case submission succeeds
onError
Fired when an error occurs
onSignInRedirect
Fired when popu window redirects to login page
onSignInRequest
Fires when user sign-in is requested
Event Payload:
-
data
ArrayAn array that contains information for supported sign-in types. i.e. [{ type: "MSA", policy: "MBI_SSL" }, { type: "ADD" }]
onSubmittingCase
Fires when submitting case
onUnloaded
Fired when the ui component is closed
onWorkflowLoaded
Fires when workflow loaded