Class: CCEverywhere
Class to create CCEverywhere object.
Extends
Implements
Constructors
Constructor
Copied to your clipboardnew CCEverywhere(validator,hostInfo,configParams,authProvider,clientAuthProvider): CCEverywhere;
Parameters
Parameter | Type |
---|---|
validator | Validator |
hostInfo | |
configParams | |
authProvider | AuthProvider |
clientAuthProvider |
Returns
CCEverywhere
Hidden
-- hide from typedocs Constructor to initialize CCEverywhere object.
Overrides
Properties
Property | Modifier | Type |
---|---|---|
readonly | ||
readonly | ||
readonly |
Accessors
activeInstance
Get Signature
Copied to your clipboardget static activeInstance():| undefined| CCEverywhereBase;
Hidden
-- hide from typedocs
Returns
| undefined
| CCEverywhereBase
Set Signature
Copied to your clipboardset static activeInstance(instance): void;
Parameters
Parameter | Type |
---|---|
instance | | undefined | CCEverywhereBase |
Returns
void
Inherited from
CCEverywhereBase
.activeInstance
state
Get Signature
Copied to your clipboardget static state(): State;
Hidden
-- hide from typedocs
Returns
Set Signature
Copied to your clipboardset static state(value): void;
Hidden
-- hide from typedocs
Parameters
Parameter | Type |
---|---|
value |
Returns
void
Inherited from
version
Get Signature
Copied to your clipboardget version(): string;
Get version of SDK
Hidden
-- hide from typedocs
Returns
string
Inherited from
Methods
terminate()
Copied to your clipboardterminate(): void;
Method to un-initialize cceverywhere object
Returns
void
Hidden
-- hide from typedocs
Inherited from
close()
Copied to your clipboardclose(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.
Implementation of
Inherited from
onRequestIdUpdate()
Copied to your clipboardonRequestIdUpdate(requestId): void;
Parameters
Parameter | Type |
---|---|
requestId | string |
Returns
void
Hidden
-- hide from typedocs
Inherited from
CCEverywhereBase
.onRequestIdUpdate