Class: abstract CCEverywhereBase
Class to create CCEverywhere object.
Extended by
Implements
RequestIdUpdateListener
Constructors
Constructor
new CCEverywhereBase(
validator,
authControllerConstructor,
hostInfo,
configParams,
authProvider,
clientAuthProvider): CCEverywhereBase;
Constructor to initialize CCEverywhere object.
Parameters
Parameter
Type
Description
validatorBaseValidator-
authControllerConstructorAuthControllerConstructor-
authProviderAuthProvider-
Returns
CCEverywhereBase
Accessors
activeInstance
Get Signature
get static activeInstance(): undefined | CCEverywhereBase;
Returns
undefined | CCEverywhereBase
Set Signature
set static activeInstance(instance): void;
Parameters
Parameter
Type
instanceundefined | CCEverywhereBaseReturns
void
state
Get Signature
get static state(): State;
Returns
Set Signature
set static state(value): void;
Parameters
Parameter
Type
valueReturns
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?booleanboolean 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
requestIdstringReturns
void
Implementation of
RequestIdUpdateListener.onRequestIdUpdate