Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Reference update to cce-release-v4-oct24 #183

Merged
merged 4 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/pages/guides/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ contributors:

# Changelog

## [4.16.11] - 2024-11-18

### Enhancements

- [`CCEverywhere.appConfig.imageStyleReference`](../../v4/shared/src/types/module/AppConfig.types/interfaces/TextToImageAppConfig.md#properties): in a `createImageFromText()` module, assets can be passed as style reference from host application via `appConfig`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a sample here?

- [`CCEverywhere.appConfig.imageCompositionReference`](../../v4/shared/src/types/module/AppConfig.types/interfaces/TextToImageAppConfig.md#properties): in a `createImageFromText()` module, assets can be passed as composition reference from host application via `appConfig`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a sample here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it would be a good idea: we've never used the changelog as a snippet repository (I checked the add-ons, too), and given the params involved in the Embed SDK in general, it could lead to lengthy snips.
I'll rather prefer the long-term plan of adding comments and examples in the source code, and let typedoc parse and display them in the API Ref.


<!-- ### Added

- Support for Safari on iOS. The SDK will no longer throw an unsupported error when accessed via Safari on iOS. -->

### Bug Fixes

- Video Quick Action: Animate from Audio Iframe was not allowing microphone access.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us rephrase this to,

We have fixed the issue with Animate from Audio Iframe not allowing microphone access in Video Quick Action.


## [4.15.19] - 2024-10-09

### Enhancements
Expand Down
6 changes: 3 additions & 3 deletions src/pages/guides/troubleshooting/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,18 @@ You can add upto five domains with a single API key. Additionally, there is no l

### How do I enable SSO for my service?

To enable Single Sign-On (SSO) for your service, when using Adobe express Embed SDK, you need to set it up using the Adobe admin console.
To enable Single Sign-On (SSO) for your service, when using Adobe express Embed SDK, you need to set it up using the Adobe admin console.

Learn to use the Adobe Admin Console to set up [Single Sign-On (SSO)](https://helpx.adobe.com/in/enterprise/using/sso-overview.html) with your Identity provider and troubleshoot setup-related problems.

### Would Adobe need to approve the integrations before my users can start using it?

Your users can use the integrations, but, we will display a red banner indicating, `The experience powered by Adobe Express has not been approved yet`. Once we review and approve your app, we will remove this banner.
Your users can use the integrations, but, we will display a red banner indicating, `The experience powered by Adobe Express has not been approved yet`. Once we review and approve your app, we will remove this banner.

### What is the versioning strategy for the SDK?

The SDK follows a continous release model, with newer versions including bug fixes and feature enhancements. We are no longer approving integrations using using SDK V1, V2, or V3.

V1 and V2 are deprecated and V3 will be deprecated in 2024.

Please migrate to V4 as soon as possible: we've created a [Migration Guide](../concepts/migration_v3_v4.md) to help you with the transition.
Please migrate to V4 as soon as possible: we've created a [Migration Guide](../concepts/migration_v3_v4.md) to help you with the transition.
Original file line number Diff line number Diff line change
Expand Up @@ -732,6 +732,18 @@ BRIDGE: object;
CLIENT_ID: string;
```

### CLIENTS.ACROBAT\_EXT

```ts
ACROBAT_EXT: object;
```

### CLIENTS.ACROBAT\_EXT.CLIENT\_ID

```ts
CLIENT_ID: string;
```

### CLIENTS.TEST\_APP

```ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
| ------ | ------ |
| `OTHER` | `"Other"` |
| `ACROBAT` | `"Acrobat"` |
| `ACROBAT_EXT` | `"ACROBAT_EXT"` |
| `CCD` | `"CCD"` |
| `CONTENT_CAL` | `"CONTENT_CAL"` |
| `STOCK` | `"STOCK"` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ Params to configure the application.

| Property | Type | Description |
| ------ | ------ | ------ |
| `env?` | [`Environment`](../enumerations/Environment.md) | 1P only |
| `locale?` | `string` | @TJS-pattern ^[a-z]{2}([_-]([A-Za-z]{2,4}))?([_-][A-Z]{2})?$ |
| `skipBrowserSupportCheck?` | `boolean` | **Default** `false` |
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This interface describes the properties provided by client.

| Property | Type | Description |
| ------ | ------ | ------ |
| `clientId` | `string` | Client id generated from dev console. Environment(stage/prod) specific client id should be passed. |
| `clientId` | `string` | For 3P - Client id generated from dev console. For 1P - Client id generated from IMSS portal. Environment(stage/prod) specific client id should be passed). |
| `appName` | `string` | Client's application name. This name may be used in creating folder for projects in target application. |
| `appVersion?` | [`Version`](../../Version.types/interfaces/Version.md) | Client's current version. |
| `platformCategory?` | [`PlatformCategory`](../enumerations/PlatformCategory.md) | Client's application type. |
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Type Alias: AppConfig

```ts
type AppConfig: EditorAppConfig;
type AppConfig: EditorAppConfig1P & EditorAppConfig;
```
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
| `editorTitle?` | `string` | Property to configure the title | - |
| `promptText?` | `string` | - | - |
| `imageDimensions?` | [`ImageDimensions`](../../../Asset.types/type-aliases/ImageDimensions.md) | The dimensions of the image that the user can generate. If provided, the user will be restricted to generating images of the specified dimensions. | - |
| `imageStyleReference?` | [`Asset`](../../../Asset.types/type-aliases/Asset.md) | Asset to be passed as style reference for generating images | - |
| `imageCompositionReference?` | [`Asset`](../../../Asset.types/type-aliases/Asset.md) | Asset to be passed as composition reference for generating images | - |
Loading