cc-everywhere

Abstract Class: CCEverywhereBase

Class to create CCEverywhere object.

Extended by

Implements

Constructors

Constructor

new CCEverywhereBase(
   validator, 
   authControllerConstructor, 
   hostInfo, 
   configParams, 
   authProvider, 
   clientAuthProvider, 
   piipStatus): CCEverywhereBase;

Constructor to initialize CCEverywhere object.

Parameters

Parameter
Type
Default value
Description
validator
BaseValidator
undefined
-
authControllerConstructor
AuthControllerConstructor
undefined
-
hostInfo
HostInfo
undefined
client application information - clientId, appName
configParams
ConfigParams
undefined
environment, locale, piipStatus, colorTheme, spectrumTheme, scale
authProvider
AuthProvider
undefined
-
clientAuthProvider
ClientAuthProvider
undefined
-
piipStatus
PIIPStatus
PIIPStatus.OPTED_IN
-

Returns

CCEverywhereBase

Accessors

activeInstance

Set Signature

set static activeInstance(instance): void;
Parameters
Parameter
Type
instance
CCEverywhereBase | undefined
Returns

void

Methods

close()

close(showConfirmationDialog?): 
  | boolean
| Promise<CloseStatusMessage>;

Closes any active design in progress.

Parameters

Parameter
Type
Description
showConfirmationDialog?
boolean
boolean value indicating whether to show confirmation dialog or not.

Returns

| boolean | Promise<CloseStatusMessage>

boolean value indicating whether the close operation was successful or not.