cc-everywhere

Class: ModuleWorkflow

Extends

Implements

Constructors

Constructor

new ModuleWorkflow(actionManager, context): ModuleWorkflow;

Parameters

Parameter
Type
actionManager
ActionManager
context
SDKContext

Returns

ModuleWorkflow

Inherited from

BaseWorkflow.constructor

Methods

editImage()

editImage(
   docConfig, 
   appConfig?, 
   exportConfig?, 
containerConfig?): Promise<EditImageContext>;

Perform editing tasks on any image.

Parameters

Parameter
Type
Description
docConfig
EditImageDocConfig
pass an asset to preload on to the Editor
appConfig?
EditImageAppConfig
-
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

Promise<EditImageContext>

Promise that resolves with EditImageContext when the workflow is loaded

Implementation of

ModuleWorkflow.editImage

createImageFromText()

createImageFromText(
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Generate images by just passing a text prompt.

Parameters

Parameter
Type
Description
appConfig?
TextToImageAppConfig
Pass a text prompt to generate images.
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

ModuleWorkflow.createImageFromText

startFromContent()

startFromContent(
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Open the Start From Content module.

Parameters

Parameter
Type
Description
appConfig?
StartFromContentAppConfig
properties to configure the Start From Content module
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

ModuleWorkflow.startFromContent

createDesign()

createDesign(
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Create a new design. Open template gallery as the default entry experience.

Parameters

Parameter
Type
Description
appConfig?
FDECreateDesignAppConfig
properties to configure the template browser and FDE session
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

ModuleWorkflow.createDesign

editDesign()

editDesign(
   docConfig?, 
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Edit and customize a template or document in the Focused Design Editor (FDE).

Parameters

Parameter
Type
Description
docConfig?
FDEEditDesignDocConfig
pass template configuration including docId or templateId
appConfig?
FDEEditDesignAppConfig
properties to configure the Focused Design Editor. See ThirdParty.Module.FDEEditDesignAppConfig.
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

ModuleWorkflow.editDesign

viewDesign()

viewDesign(
   docConfig, 
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Launches the design viewer for a personalized design.

Parameters

Parameter
Type
Description
docConfig
DesignViewerDocConfig
pass an asset to preload on to the viewer.
appConfig?
DesignViewerAppConfig
properties to configure the Design Viewer module
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

ModuleWorkflow.viewDesign