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.

Sign up for GitHub

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

Jump to bottom

docs: Add languages in the markdowns #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Add languages in the markdowns #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,29 @@ There are two ways to install the Zoom Apps SDK into your frontend project

You can install it from NPM, if you are using a module bundler such as Webpack:

```
```bash
$ npm install @zoom/appssdk
```

### CDN

Alternatively, you can load the SDK from a CDN, using a script tag in your HTML document:

```
```html
<script src="https://appssdk.zoom.us/sdk.js"></script>
```

You can also load a minified SDK, using a script tag in your HTML document:

```
```html
<script src="https://appssdk.zoom.us/sdk.min.js"></script>
```

## Usage

If you installed Zoom Apps SDK from NPM, import `zoomSdk` into the component where you wanted to use the SDK and call `config` as your first call to verify your application with Zoom.

```
```javascript
import zoomSdk from "@zoom/appssdk"

async function configureApp {
Expand Down Expand Up @@ -62,7 +62,7 @@ The cloud SDK is designed to provide on-demand patch updates, and it does not su

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

```
```json
{
"clientVersion": "5.11.1.8356",
"browserVersion": "applewebkit/17613.2.7.1.8",
Expand Down Expand Up @@ -94,27 +94,27 @@ Your app is developed against the 3.4.0 client version and uses the `sendAppInvi

Client version 3.4.0. The `sendAppInvitation` API schema is

```
```javascript
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

```
```javascript
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.

Original call from app to SDK

```
```javascript
sendAppInvitation ({ participantUUIDs: [participantUUID1, participantUUID2, ...], })
```

SDK transforms the call internally to

```
```javascript
sendAppInvitation ({ participantUUIDs: [participantUUID1, participantUUID2, ...], message: ""})
```

Expand Down