cc-everywhere

Class: abstract CCEverywhereBase

Class to create CCEverywhere object.

Extended by

Implements

Constructors

Constructor

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

Constructor to initialize CCEverywhere object.

Parameters

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

Returns

CCEverywhereBase

Accessors

activeInstance

Get Signature

get static activeInstance(): undefined | CCEverywhereBase;
Returns

undefined | CCEverywhereBase

Set Signature

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

void

state

Get Signature

get static state(): State;
Returns

State

Set Signature

set static state(value): void;
Parameters
Parameter
Type
value
State
Returns

void

version

Get Signature

get version(): string;

Get version of SDK

Returns

string

Methods

terminate()

terminate(): void;

Method to un-initialize cceverywhere object

Returns

void

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.

onRequestIdUpdate()

onRequestIdUpdate(requestId): void;

Parameters

Parameter
Type
requestId
string

Returns

void

Implementation of

RequestIdUpdateListener.onRequestIdUpdate