Edit in GitHubLog an issue

SDK Reference

This is the main API for accessing all Adobe Express Embed SDK components. The initialize() method takes HostInfo and an optional ConfigParams, and returns a Promise with a CCEverywhere object. The v2 release introduces a new method: terminate().

initialize()

Note: As of March 2023, the redirectUri parameter is no longer being checked by v2. You no longer need to include it in the initialize() method. The exchangeAuthCodeForToken() API no longer needs to be called.

initialize: (HostInfo, ConfigParams?) => Promise<null | CCEverywhere>

The default method initialize() is the API used to initialize the SDK. Make sure to call it only once a page. With the v2 release of the SDK, this method is now async.

Copied to your clipboard
// after loading the SDK into the window
await window.CCEverywhere.initialize(
/* HostInfo */
{
clientId: YOUR_CLIENT_ID,
appName: YOUR_PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web',
},
/* ConfigParams (optional) */
{
locale: 'en_US',
}
);

HostInfo

PropertyTypeDescription
clientId
string
Your API Key
appName
string
Name of project folder created in user's Adobe Express account
appVersion
{ major: number, minor: number, patch?: number}
Your app version
platformCategory
'web'
Specify host app platform

ConfigParams

The locale field defaults to 'en_US' if nothing is specified. Visit the customization page for a full locale list.

PropertyTypeDescription
locale
string
Language settings for SDK components

CCEverywhere

The CCEverywhere object is the object returned (wrapped in a promise) when the SDK is initialized.

As of today, it exposes 4 methods:

  1. openQuickAction(): Quick actions component
  2. createDesign(): Full editor component
  3. editDesign(): Full editor component

terminate()

terminate: () => boolean

The default method terminate() is available with v2.0.1+ of the SDK. This method will:

  • Return true once it successfully terminates the active instance of CCEverywhere
  • Return false if there is no active CCEverywhere instance.

Next steps

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.