openQuickAction()

data-variant=error

data-slots=header, text

IMPORTANT: Deprecation Warning

We are no longer approving integrations using v1 or v2 of the SDK - both versions will be deprecated in 2024.

This API is used for opening a quick action.

openQuickAction: (quickActionParams: QuickActionParams): void

QuickActionParams

Besides id, all other properties are optional.

Property
Type
Description
id
QuickActionId
Specify which quick action to open.
callbacks
Callbacks
Callback methods
modalParams
ModalParams
Parameters to configure modal UI
inputParams
QuickActionInputParams
Input parameters when opening a quick action.
outputParams
CCXOutputParams
Desired output options when exporting assets from a quick action.

QuickActionId

This ID is associated with the quick action you want to surface to your user.

Quick Action
QuickActionId
Type
Crop image
'crop-image'
Image
Convert to JPG
'convert-to-jpg'
Image
Convert to PNG
'convert-to-png'
Image
Resize image
'resize-image'
Image
Remove background
'remove-background'
Image
Generate QR code
'generate-qr-code'
Image
Convert to GIF
'convert-to-gif'
Video
Convert to MP4
'convert-to-mp4'
Video
Crop video
'crop-video'
Video
Merge videos
'merge-videos'
Video
Resize video
'resize-video'
Video
Trim video
'trim-video'
Video
Animate from audio
'animate-from-audio'
Video
Caption video
'caption-video'
Video

QuickActionInputParams

Input parameters for quick actions. All the properties are optional.

Property
Type
Description
exportOptions
ExportOptions[]
Export options for the asset that is created. These options will be visible in the quick action editor.
asset
Asset or Asset[]
Asset from the host application to start editing with. Array of assets only accepted for merge video quick action.
receiveTargetErrors
boolean
Boolean that tells client whether or not to receive target application errors.