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.
Copied to your clipboardinitialize: (hostInfo: HostInfo, configParams?: ConfigParams) => Promise<CCEverywhere>
HostInfo
Property | Required | Type | Description |
---|---|---|---|
clientId | Yes | String | API key from Developer Console |
appName | Yes | String | Name of project folder created in your user's Adobe Express account. This should correspond to the name of your application. |
appVersion | No | { major: number, minor: number, patch?: number } | Version of your integration |
platformCategory | No | 'web' | Specify host app platform |
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.
Property | Required | Type | Description |
---|---|---|---|
locale | No | Language settings for SDK components | |
skipBrowserSupportCheck | No | boolean | When set to true and browser is not supported, calling initialize() will not result in an error. |
loginMode | No | string | When set to delayed , user won't be asked to sign in until they export |
Example
Copied to your clipboard(async () => {let hostInfo = { /* HostInfo */clientId: CLIENT_ID,appName: APP_NAME,appVersion: { major: 1, minor: 0 },platformCategory: 'web',}const configParams = {loginMode: 'delayed'}const ccEverywhere = await window.CCEverywhere.initialize(hostInfo, configParams);})();
The returned Promise-wrapped CCEverywhere
object can then be used to access the other APIs of the SDK:
editor
: Create a design from scratch or from a starting asset in a full editor.quickAction
: Launches a quick action.module
: Opens a module in a modal.