cc-everywhere

Interface: ModuleWorkflow

Methods

editImage()

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

Parameters

Returns

Promise<EditImageContext>

createImageFromText()

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

Parameters

Returns

void

startFromContent()

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

Open the Start From Content module.

Parameters

Returns

void

createDesign()

createDesign(
   appConfig?, 
   exportConfig?, 
   containerConfig?
): Promise<DesignContext>;

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

Parameters

Returns

Promise<DesignContext>

Promise resolving with DesignContext when loaded; rejects on failure or cancellation.

editDesign()

editDesign(
   docConfig?, 
   appConfig?, 
   exportConfig?, 
   containerConfig?
): Promise<DesignContext>;

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

Parameters

Returns

Promise<DesignContext>

Promise resolving with DesignContext when loaded; rejects on failure or cancellation.

viewDesign()

viewDesign(
   docConfig?, 
   appConfig?, 
   exportConfig?, 
   containerConfig?
): Promise<IDesignViewerContext>;

Launches the design viewer for a personalized design.

Parameters

Returns

Promise<IDesignViewerContext>

Promise that resolves with the DesignViewerContext when the workflow is loaded. Call IDesignViewerContext.updateDesignAssets on it to update the asset(s) rendered in the open viewer.

migrateAssets()

migrateAssets(documentIds): Promise<MigrateAssetsResult>;

Migrate a transitioning user's guest documents to their newly signed-in account.

Requires the SDK to be initialized with a PartnerAssertionAuthOption whose config is a TransitionAssertionConfig (both guest and user assertions present). Runs headlessly (no UI) in the Focused Design Editor.

Parameters

Returns

Promise<MigrateAssetsResult>

Promise resolving with a Module.MigrateAssetsResult mapping each input document id to its migrated output id; rejects on migration error or after a 180-second timeout.