express-embed-mobile-sdk-ios-release

ModuleWorkflowInterface

public protocol ModuleWorkflowInterface

Module workflow interface providing access to comprehensive creative editing workflows.

[createImageFromText(textToImageAppConfig:exportConfig:containerConfig:)](#/s:9embed_sdk23ModuleWorkflowInterfaceP19createImageFromText06textToG9AppConfig06exportM009containerM0AA22EmbedSdkViewControllerCAA0ikglM0VSg_SayAA23BaseExportOptionOrGroupCGSgAA0t9ContainerM0CSgtKF)

Creates and displays the Generate Image from Text workflow.

Throws

CCEverywhereError if SDK is not initialized or configuration is invalid

Declaration

Swift

func createImageFromText(
    textToImageAppConfig: TextToImageAppConfig?,
    exportConfig: ExportConfig?,
    containerConfig: ContainerConfig?
) throws -> EmbedSdkViewController

Parameters

`textToImageAppConfig`	Configuration for the text-to-image workflow including editor title, prompt text, image dimensions, and callbacks (optional)
`exportConfig`	Export configuration specifying available export actions and UI styling (optional)
`containerConfig`	Container configuration for display settings like background color, loader visibility, and timeout (optional)

Return Value

EmbedSdkViewController instance that can be presented by the host application

[editImage(editImageDocConfig:editImageAppConfig:exportConfig:containerConfig:)](#/s:9embed_sdk23ModuleWorkflowInterfaceP9editImage0fG9DocConfig0fg3AppI006exportI009containerI0AA04EditG22EmbedSDKViewControllerCAA0mghI0C_AA0mgjI0VSgSayAA23BaseExportOptionOrGroupCGSgAA0q9ContainerI0CSgtKF)

Opens the Edit Image workflow for comprehensive image editing.

Throws

CCEverywhereError if SDK is not initialized, asset is invalid, or configuration is invalid

Declaration

Swift

func editImage(
    editImageDocConfig: EditImageDocConfig,
    editImageAppConfig: EditImageAppConfig?,
    exportConfig: ExportConfig?,
    containerConfig: ContainerConfig?
) throws -> EditImageEmbedSDKViewController

Parameters

`editImageDocConfig`	Document configuration containing the image asset to edit and optional editing intent (required)
`editImageAppConfig`	Application configuration for the editor including title, metadata, and callbacks (optional)
`exportConfig`	Export configuration specifying available export actions (optional)
`containerConfig`	Container configuration for display settings (optional)

Return Value

EditImageEmbedSDKViewController containing the view controller and EditImageContext for interacting with the active editing session

[warmup(intent:mode:)](#/s:9embed_sdk23ModuleWorkflowInterfaceP6warmup6intent4modeyAA12ActionIntentC_AA10WarmupModeOtKF)

Pre-loads SDK resources for faster subsequent workflow launches.

Throws

CCEverywhereError if SDK is not initialized or intent is invalid

Declaration

Swift
```
func warmup(
    intent: ActionIntent,
    mode: WarmupMode
) throws
```
Parameters

intent
The workflow intent to warm up (e.g., EDIT_IMAGE_V2, CREATE_IMAGE_FROM_TEXT)
mode
WarmupMode
[purgeWarmupSession(intent:)](#/s:9embed_sdk23ModuleWorkflowInterfaceP18purgeWarmupSession6intentSbAA12ActionIntentCSg_tKF)

Purge the background warmup session for the given intent. This closes any preload/precache WebView and ends the warmup action.

Declaration

Swift
```
func purgeWarmupSession(intent: ActionIntent?) throws -> Bool
```
Return Value

true if warmup session was successfully purged, false otherwise
[activePreloadIntent()](#/s:9embed_sdk23ModuleWorkflowInterfaceP19activePreloadIntentShyAA06ActionH0CGSgyKF)

Declaration

Swift
```
func activePreloadIntent() throws -> Set<ActionIntent>?
```
Return Value

ActionIntent for the active preload session or null if no session is active

`intent`	The workflow intent to warm up (e.g., EDIT_IMAGE_V2, CREATE_IMAGE_FROM_TEXT)
`mode`	WarmupMode