API Docs for: 2.0.17170.2
Show:

ui.survey.Config Class

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

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

environment

Environment

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

The survey ux environment to use.

flightId

String

Defined in src\internal\ui\Survey\config.ts:28

Override the flight ID. Used for debugging purposes only

locale

String

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

Locale to render the survey in.

partnerContext

String

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

The survey platform environment to use. Will be converted to KVP

preview

Boolean

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

Use compass preview data. Used for debugging purposes only

surveyId

String

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

ID for the survey to render

surveyPlatformEnvironment

String

Defined in src\internal\ui\Survey\config.ts:52

The survey platform environment to use.

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.

viewMode

String

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

Optional view mode to disaplay the survey in. Default is Wizard view

Events

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

onSurveyComplete

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

Fires when the survey is complete

Event Payload:

  • data Object

    A data object that is passed through the event

    • Submitted Object

      True if the user submitted the survey. False if they cancelled.

onSurveyComplete

Defined in src\internal\ui\Survey\config.ts:72

Fires when the survey is rendered

onUnloaded

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

Fired when the ui component is closed