Initialize SDK

initialize()

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 SDK should be initialized only once on each page. This method is async.

Copy
initialize: (hostInfo: HostInfo, configParams?: ConfigParams) => Promise<CCEverywhere>
Copied to your clipboard
initialize: (hostInfo: HostInfo, configParams?: ConfigParams) => Promise<CCEverywhere>

HostInfo

ConfigParams

The Adobe Express Embed SDK can be initialized with a customized locale. This field defaults to 'en_US' if nothing is specified. The full list of accepted locale strings is here.

Example

Copy
(async () => {
  let host = { /* HostInfo */
    clientId: CLIENT_ID,
    appName: APP_NAME, 
    appVersion: { major: 1, minor: 0 }, 
    platformCategory: 'web',
  }

  let config = { locale = 'en_US'} /* ConfigParams (optional) */

  const ccEverywhere = await window.CCEverywhere.initialize(host, config);
})();
Copied to your clipboard
(async () => {
  let host = { /* HostInfo */
    clientId: CLIENT_ID,
    appName: APP_NAME, 
    appVersion: { major: 1, minor: 0 }, 
    platformCategory: 'web',
  }

  let config = { locale = 'en_US'} /* ConfigParams (optional) */

  const ccEverywhere = await window.CCEverywhere.initialize(host, config);
})();

The returned Promise-wrapped CCEverywhere object can then be used to call the other APIs of the SDK:

1. createDesign(): Create a design from scratch or from a starting asset in the editor.
2. editDesign(): Edit a design in the editor.
3. openQuickAction(): Open a quick action in a modal.
4. close(): Closes any active design in progress. It returns a boolean value indicating whether the close operation was successful or not.
5. terminate(): Terminates the active CCEverywhere instance. Returns void.

Last updated 10/11/2024

Was this helpful?

Yes

No