cc-everywhere

Class: CCEverywhere

Class to create CCEverywhere object.

Extends

Implements

Constructors

Constructor

new CCEverywhere(
   validator, 
   hostInfo, 
   configParams, 
   authProvider, 
   clientAuthProvider): CCEverywhere;

Parameters

Parameter
Type
validator
Validator
hostInfo
HostInfoSpecifiedBase
configParams
ConfigParamsBase
authProvider
AuthProvider
clientAuthProvider
ClientAuthProvider

Returns

CCEverywhere

Overrides

CCEverywhereBase.constructor

Properties

Property
Modifier
Type
editor
readonly
EditorWorkflow
module
readonly
ModuleWorkflow
quickAction
readonly
QuickActionWorkflow

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

Inherited from

CCEverywhereBase.activeInstance

state

Get Signature

get static state(): State;
Returns

State

Set Signature

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

void

Inherited from

CCEverywhereBase.state

version

Get Signature

get version(): string;

Get version of SDK

Returns

string

Inherited from

CCEverywhereBase.version

Methods

terminate()

terminate(): void;

Method to un-initialize cceverywhere object

Returns

void

Inherited from

CCEverywhereBase.terminate

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.

Implementation of

CCEverywhereInterface.close

Inherited from

CCEverywhereBase.close

onRequestIdUpdate()

onRequestIdUpdate(requestId): void;

Parameters

Parameter
Type
requestId
string

Returns

void

Inherited from

CCEverywhereBase.onRequestIdUpdate