Skip to content

Commit

Permalink
0.16.11
Browse files Browse the repository at this point in the history
  • Loading branch information
NarmadaRavali committed Mar 31, 2023
1 parent 3d2e3fa commit 3201c3c
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 30 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,9 @@ async function configureApp() {
}
```


The cloud SDK is designed to provide on-demand patch updates, and it does not support exact versions. You will always get the latest patch version within the major version specified in the version parameter of `zoomSdk.config`. In other words, if you supplied an exact version like `0.16.1`, you will get the latest patch within the `0.16` major version.

`zoomSdk.config` response object. Read more about [zoomSdk.config](https://marketplace.zoom.us/docs/zoom-apps/js-sdk/reference/)
`zoomSdk.config` response object. Read more about [zoomSdk.config](https://appssdk.zoom.us/classes/ZoomSdk.ZoomSdk.html#config)

```
{
Expand All @@ -85,6 +84,7 @@ The cloud SDK is designed to provide on-demand patch updates, and it does not su
- The SDK module installed via npm includes the `sdk.d.ts` file which provides type definitions for `sdk.es.js` and `sdk.module.js`. The cloud-based SDK does not provide this file.

### How do compatibility patches work?

This is an example of how compatibility patches delivered via cloud-based SDK help your app run on the latest client versions.

**Note**: This example is only for illustrating the concept, and does not imply Zoom is planning to change the `sendAppInvitation` API schema.
Expand All @@ -99,9 +99,9 @@ sendAppInvitation ({ participantUUIDs: [participantUUID1, participantUUID2, ...]
```

Client version 4.0.0 introduces a breaking change to the `sendAppInvitation` API that requires one additional parameter `message` to customize your invitation. The new API schema is
```
sendAppInvitation ({ participantUUIDs: [participantUUID1, participantUUID2, ...], message: "This app is awesome, try it!"})

```
sendAppInvitation ({ participantUUIDs: [participantUUID1, participantUUID2, ...], message: "This app is awesome, try it!"})
```

Apps based on the client version 3.4.0 will break when used on the 4.0.0 client because the client is expecting the `message` parameter as part of the API call. Whereas, when you use the cloud-based SDK, the compatibility patch can accept your API request and transform it internally to use a default value for the `message` parameter.
Expand All @@ -120,23 +120,22 @@ sendAppInvitation ({ participantUUIDs: [participantUUID1, participantUUID2, ...]

## Documentation

Refer to Apps SDK documentation [here](https://marketplace.zoom.us/docs/zoom-apps/js-sdk/reference).
Refer to Apps SDK documentation [here](https://appssdk.zoom.us/classes/ZoomSdk.ZoomSdk.html).

## Release notes

Refer to [release notes](https://github.com/zoom/appssdk/releases) to discover changes made in the Apps SDK.

## Resources to create a Zoom App

- Create your first Zoom App following these [steps](https://marketplace.zoom.us/docs/zoom-apps/getstarted).
- To help you start developing Zoom Apps we also provide sample reference [apps](https://marketplace.zoom.us/docs/zoom-apps/referenceapp#quick-start-reference-apps).
- Create your first Zoom App following these [steps](https://developers.zoom.us/docs/zoom-apps/create/).
- To help you start developing Zoom Apps we also provide sample reference [apps](https://developers.zoom.us/docs/zoom-apps/reference-apps/).
- Watch [How To Create a Zoom App](https://www.youtube.com/watch?v=otlyDxnU-RI) and [How To Configure the Basic Zoom App](https://www.youtube.com/watch?v=SS87nqO9ScQ).
- Discover more learning [resources](https://marketplace.zoom.us/docs/zoom-apps/introduction) for Zoom Apps Development.
- Discover more learning [resources](https://developers.zoom.us/docs/zoom-apps/) for Zoom Apps Development.
- Zoom Apps SDK on [npm](https://www.npmjs.com/package/@zoom/appssdk).

## Need help?

- If you are looking for help, try [Developer Support](https://devsupport.zoom.us/hc/en-us) or our [Developer Forum](https://devforum.zoom.us/).
- If you are looking for help, try [Developer Support](https://devsupport.zoom.us/hc/en-us) or our [Developer Forum](https://devforum.zoom.us/).
- For questions related to Zoom Apps please direct them to [Zoom Apps](https://devforum.zoom.us/c/zoom-apps/39) category in the forum.
- Priority support is also available with [Premier Developer Support](https://explore.zoom.us/docs/en-us/developer-support-plans.html) plans.

Loading

0 comments on commit 3201c3c

Please sign in to comment.