Skip to content

Commit

Permalink
Marked Audio/User stable, new video, removed dropbox
Browse files Browse the repository at this point in the history
  • Loading branch information
hollyschinsky committed Sep 27, 2023
1 parent 37177c8 commit a6a95f6
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 21 deletions.
6 changes: 3 additions & 3 deletions src/pages/guides/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ async function addImageFromURL(url) {
The supported file types for imported images are currently **`png/jpg/mp4`,** and the size of the imported images should not exceed **8000px** or **40MB**. See the [SDK References](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/) for additional details on importing content.

### Video and Audio Content
You can also import video and audio content in a similar way as described above, via the [`addVideo()`](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/#addvideo) and [`addAudio()`](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document#addaudio) methods accordingly. **Please note:** the `addAudio()` method specifically is currently in *experimental mode only*, and requires an additional `MediaAttributes` object parameter containing the `title` of the audio object you're importing. See the associated [SDK Reference](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/#methods) for more details and example usage.
You can also import video and audio content in a similar way as described above, via the [`addVideo()`](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/#addvideo) and [`addAudio()`](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document#addaudio) methods accordingly. **Please note:** the `addAudio()` method requires an additional `MediaAttributes` object parameter containing the `title` of the audio object you're importing. See the associated [SDK Reference](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/#methods) for more details and example usage.

## Exporting Content
Another popular feature available for use in your add-on is the ability to export content. For instance, if you want to allow the user to save/download the current design, (or range of a design), with certain export configurations to their local hard drive. Some examples for exporting content are provided below, but also check out the [`createRenditions` section in the SDK Reference](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/#createrenditions) for more specific options and details, as well as the [export-sample add-on](https://developer.adobe.com/express/add-ons/docs/samples/#export-sample).
Expand Down Expand Up @@ -169,7 +169,7 @@ document.querySelector("#export").onclick = async () => {
## Authorization with OAuth 2.0
This use case focuses on providing an authorization feature that allows a user to login to one of their existing services with OAuth 2.0. A typical use case would be to use assets you have stored in another service. Here you will find instructions of how to set it up, and an example of how to implement it. But also check out the [SDK Reference OAuth section](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-oauth/) for more options and details, as well as the [import-images-using-oauth](https://developer.adobe.com/express/add-ons/docs/samples/#import-images-using-oauth) and [Dropbox](https://developer.adobe.com/express/add-ons/docs/samples/#dropbox) sample add-ons for more advanced usage.
This use case focuses on providing an authorization feature that allows a user to login to one of their existing services with OAuth 2.0. A typical use case would be to use assets you have stored in another service. Here you will find instructions of how to set it up, and an example of how to implement it. But also check out the [SDK Reference OAuth section](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-oauth/) for more options and details, as well as the [import-images-using-oauth](https://developer.adobe.com/express/add-ons/docs/samples/#import-images-using-oauth) sample add-ons for more advanced usage.
### Setup
The OAuth APIs can be used to obtain the authorization "code" from any OAuth 2.0 provider supporting the Code Exchange authorization workflow. You will need to go through some setup steps with the provider you want to use OAuth with first. Here are the steps to get started:
Expand Down Expand Up @@ -293,7 +293,7 @@ async function displayAllItems() {
```
## Drag and Drop
If you want to allow a user to drag and drop items from your add-on to the document, you can use the [methods provided in the add-on SDK](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/addonsdk-app/#enabledragtodocument). There are also several [code samples](https://developer.adobe.com/express/add-ons/docs/samples) that implement drag and drop, including the [import-images-using-oauth](https://developer.adobe.com/express/add-ons/docs/samples/#import-images-using-oauth), [Dropbox](https://developer.adobe.com/express/add-ons/docs/samples/#dropbox), [pix](https://developer.adobe.com/express/add-ons/docs/samples/#pix) and more that you can reference. Some example use cases are shown below. **Note:** for dragging audio content (which is currently experimental), you will need to specify an additional `attributes` object that includes a `title` property. A note on how to include it specifically is below in the [second example below](#example-using-an-image-url).
If you want to allow a user to drag and drop items from your add-on to the document, you can use the [methods provided in the add-on SDK](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/addonsdk-app/#enabledragtodocument). There are also several [code samples](https://developer.adobe.com/express/add-ons/docs/samples) that implement drag and drop, including the [import-images-using-oauth](https://developer.adobe.com/express/add-ons/docs/samples/#import-images-using-oauth) and [pix](https://developer.adobe.com/express/add-ons/docs/samples/#pix) samples you can reference. Some example use cases are shown below. **Note:** for dragging audio content, you will need to specify an additional `attributes` object that includes a `title` property. A note on how to include it specifically is below in the [second example below](#example-using-an-image-url).
### Example using local images
```js
Expand Down
4 changes: 2 additions & 2 deletions src/pages/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Preview Adobe Express add-on SDK documentation while you wait to [join our priva
Add-ons extend the functionality of [Adobe Express](https://new.express.adobe.com/), unlocking creative workflows for Adobe Express users. The add-ons marketplace is a dedicated platform for developers to distribute and users to discover new add-ons. Check out this quick introduction to Adobe Express add-ons to learn more, then read on to get started. <br/><br/>

<div style="display: flex; justify-content: center;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/RNHsCQ9TPd8" title="Introduction to Adobe Express Add-ons" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>
<iframe width="560" height="315" src="https://www.youtube.com/embed/CHBiTTN1neE" title="Introduction to Adobe Express Add-ons" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div><br/>

To discover add-ons in [Adobe Express](https://new.express.adobe.com/new):

Expand Down
6 changes: 3 additions & 3 deletions src/pages/references/addonsdk/addonsdk-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Provides access to the Adobe Express host application's properties and methods t
<td class="spectrum-Table-cell"><p>Represents the current user accessing the host application</p></td>
</tr>
<tr class="spectrum-Table-row">
<td class="spectrum-Table-cell"><p><pre>readonly</pre></p></td>
<td class="spectrum-Table-cell"><p><pre></pre></p></td>
<td class="spectrum-Table-cell"><p><pre><a href="app-devFlags.md">devFlags</a></pre></p></td>
<td class="spectrum-Table-cell"><p><pre>object</pre></p></td>
<td class="spectrum-Table-cell"><p>Represents flags which can be used to simulate certain behavior during development.</p></td>
Expand Down Expand Up @@ -242,9 +242,9 @@ Returned as part of an array from the [`DragCompletionCallback`](#dragcallbacks)
| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes to pass when adding the audio to the page (ie: `title`, which is mandatory). |


<InlineAlert slots="text" variant="warning"/>
<!-- <InlineAlert slots="text" variant="warning"/>
**IMPORTANT:** The support for drag and drop of **audio** specifically is currently **experimental only** and should not be used in any add-ons you will be distributing until it's been declared stable. To enable this support, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`. See this [Drag & Drop use case code snippet](../../guides/develop/index.md#example-using-an-image-url) for an example note of how to specify the properties for audio specifically.
**IMPORTANT:** The support for drag and drop of **audio** specifically is currently **experimental only** and should not be used in any add-ons you will be distributing until it's been declared stable. To enable this support, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`. See this [Drag & Drop use case code snippet](../../guides/develop/index.md#example-using-an-image-url) for an example note of how to specify the properties for audio specifically. -->


#### `MediaAttributes`
Expand Down
4 changes: 2 additions & 2 deletions src/pages/references/addonsdk/app-currentUser.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# AddOnSdk.app.currentUser
Provides access to the currently logged in user.

<InlineAlert slots="text" variant="warning"/>
<!-- <InlineAlert slots="text" variant="warning"/>
**IMPORTANT:** This API is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it's been marked stable. To use this API, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`.

-->

## Methods

Expand Down
4 changes: 2 additions & 2 deletions src/pages/references/addonsdk/app-devFlags.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AddOnSdk.app.devFlags
Represents flags which can be used to simulate certain behavior during development.
This object contains flags which can be used to simulate certain behavior during development.

<InlineAlert slots="text" variant="warning"/>

This API can only be used during development.
`AddOnSdk.app.devFlags` are provided for testing purposes only, and thus can only be used during the development phase.


## Methods
Expand Down
5 changes: 0 additions & 5 deletions src/pages/references/addonsdk/app-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,6 @@ async function addVideoFromURL(url) {
### addAudio()
Adds audio to the current page.

<InlineAlert slots="text" variant="warning"/>

**IMPORTANT:** This new method is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it's been declared stable. To try out these new APIs, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`.


#### Signature
`addAudio(audioBlob: Blob, attributes: MediaAttributes): Promise<void>`

Expand Down
14 changes: 12 additions & 2 deletions src/pages/references/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ contributors:

# Changelog

## 2023-09-26
### Removed
- Removed the experimental APIs notes/warnings around the **Audio APIs and User APIs** since they **are now stable**.
- Removed references to the Dropbox sample since the [import-images-from-oauth](https://developer.adobe.com/express/add-ons/docs/samples/#import-images-using-oauth) contains the same functionality.

### Updated
- Updated the Express add-ons [introduction video](https://developer.adobe.com/express/add-ons/docs/guides/) with a newly created version.



## 2023-09-25
### Updates
The [Editor API references](https://developer.adobe.com/express-add-on-apis/docs/api/classes/Editor/) have been updated with additional descriptions and details as well as some new an modified APIs:
Expand Down Expand Up @@ -81,9 +91,9 @@ Added new **Audio API** documentation. You can now import audio to the current A



<InlineAlert slots="text" variant="warning"/>
<!-- <InlineAlert slots="text" variant="warning"/>
**IMPORTANT:** The new Audio API's are currently ***experimental only*** and should not be used in any add-ons you will be distributing until they have been deemed stable. To try out these new APIs, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`.
**IMPORTANT:** The new Audio API's are currently ***experimental only*** and should not be used in any add-ons you will be distributing until they have been deemed stable. To try out these new APIs, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`. -->



Expand Down
25 changes: 23 additions & 2 deletions src/pages/samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Demonstrates the use of the [SWC-React](https://opensource.adobe.com/spectrum-we
<!-- # Marketplace Add-on Samples
The following samples were built to show how to use specific some popular 3rd party services. -->

## [Dropbox](https://github.com/AdobeDocs/express-add-on-samples/tree/main/marketplace/dropbox)
<!-- ## [Dropbox](https://github.com/AdobeDocs/express-add-on-samples/tree/main/marketplace/dropbox)
Allows users to connect to their Dropbox account. Once connected, they can fetch their images and videos from their account and add them to their Express pages.
**Technologies Used:** <br/>
Expand All @@ -195,7 +195,7 @@ Allows users to connect to their Dropbox account. Once connected, they can fetch
- [OAuth API's](./references/addonsdk/app-oauth.md) to authorize the user with the Dropbox service.
- [Drag and Drop](./references/addonsdk/addonsdk-app.md#enabledragtodocument) to support dragging and dropping images to the document.
- [Import Content](./references/addonsdk/app-document.md) to add the image to the document when the gif is clicked.
- [Import Content](./references/addonsdk/app-document.md) to add the image to the document when the gif is clicked. -->

## [Giphy](https://github.com/AdobeDocs/express-add-on-samples/tree/main/marketplace/giphy)
Allows users to search for popular gifs and add them to the document.
Expand All @@ -222,3 +222,24 @@ Allows users to create a QR code based on a URL and add it to their document.

- [Import Content](./references/addonsdk/app-document.md) to add the QR Code image to the document when it's clicked.
- [Drag and Drop](./references/addonsdk/addonsdk-app.md#enabledragtodocument) to support dragging and dropping QR Codes to the document.

## Script Runtime Code Samples

The following [code samples](https://github.com/AdobeDocs/express-add-on-samples/tree/main/script-runtime-samples) have been provided to help you get started using the [Script Runtime API's](./references/scriptruntime/index.md).

<InlineAlert slots="text" variant="warning"/>

**IMPORTANT:** The [Script Runtime API's](./references/scriptruntime/index.md) are currently **experimental only**. Please do not use them in any add-ons you plan to distribute or submit with updates until they have been deemed stable.


### [communication-iframe-script-runtime sample](https://github.com/AdobeDocs/express-add-on-samples/tree/main/script-runtime-samples/communication-iframe-script-runtime)

Demonstrates the use of the communication APIs to expose and proxy APIs bidirectionally between the iframe and script runtime environments. Also includes demonstrating how to use some of the [Web APIs](./web/) such as `setTimeout()` and `console.log()`.

### [editor-apis sample](https://github.com/AdobeDocs/express-add-on-samples/tree/main/script-runtime-samples/editor-apis)

Demonstrates how to use the [editor APIs](./editor/) to create various shapes and add them to the document.

### [image-and-page sample](https://github.com/AdobeDocs/express-add-on-samples/tree/main/script-runtime-samples/image-and-page)

A more comprehensive example of using the [editor APIs](./editor/) to add a page, images and shapes, as well as clear the artboard.

0 comments on commit a6a95f6

Please sign in to comment.