Skip to content

Commit 461c3f7

Browse files
author
Tim Mendoza
committed
Update documentation
1 parent 89114ef commit 461c3f7

File tree

2 files changed

+40
-13
lines changed

2 files changed

+40
-13
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ POST /token
108108

109109
```json
110110
{
111-
"token": "0000000000000000.0000000000000000000000.00000000000000000"
111+
"token": "0000000000000000.0000000000000000000000.00000000000000000",
112+
"room_type": "group" | "group-small" | "peer-to-peer"
112113
}
113114
```
114115

@@ -208,11 +209,12 @@ USAGE
208209
$ twilio rtc:apps:video:deploy --authentication <auth>
209210
210211
OPTIONS
211-
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
212-
-p, --profile=profile Shorthand identifier for your profile.
213-
--app-directory=app-directory Name of app directory to use
214-
--authentication=(passcode) (required) Type of authentication to use
215-
--override Override an existing App deployment
212+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
213+
-p, --profile=profile Shorthand identifier for your profile.
214+
--app-directory=app-directory Name of app directory to use
215+
--authentication=(passcode) (required) Type of authentication to use
216+
--override Override an existing App deployment
217+
--room-type=(group|group-small|peer-to-peer) [default: group] Set room type
216218
217219
DESCRIPTION
218220
This command publishes two components as a Twilio Function: an application token
@@ -233,21 +235,33 @@ EXAMPLES
233235
$ twilio rtc:apps:video:deploy --authentication passcode
234236
deploying app... done
235237
Passcode: xxx xxx xxxx xxxx
238+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
239+
Room Type: group
236240
237241
# Deploy an application token server with the React app
238242
$ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
239243
deploying app... done
240-
Web App URL: https://video-app-xxxx-xxxx-dev.twil.io?passcode=xxxxxxxxxxxxxx
244+
Web App URL: https://video-app-1111-dev.twil.io?passcode=xxxxxxxxxxxxxx
241245
Passcode: xxx xxx xxxx xxxx
246+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
247+
Room Type: group
242248
243249
# Override an existing app with a fresh deployment
244250
# Please note that this will remove a previously deployed web application if no
245251
# app directory is provided
246252
$ twilio rtc:apps:video:deploy --authentication passcode --override
247253
Removed app with Passcode: xxx xxx xxxx xxxx
248254
deploying app... done
255+
Passcode: yyy yyy yyyy yyyy
256+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
257+
Room Type: group
258+
259+
# Deploy an application token server with a specific room type
260+
$ twilio rtc:apps:video:deploy --authentication passcode --room-type peer-to-peer
261+
deploying app... done
249262
Passcode: xxx xxx xxxx xxxx
250263
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
264+
Room Type: peer-to-peer
251265
```
252266

253267
## `twilio rtc:apps:video:view`
@@ -266,6 +280,7 @@ EXAMPLE
266280
$ twilio rtc:apps:video:view
267281
Web App URL: https://video-app-1111-dev.twil.io?passcode=xxxxxxxxxxxxxx
268282
Passcode: xxx xxx xxxx xxxx
283+
Room Type: group
269284
```
270285

271286
<!-- commandsstop -->

src/commands/rtc/apps/video/deploy.js

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,22 +74,34 @@ DeployCommand.examples = [
7474
`# Deploy an application token server with passcode authentication
7575
$ twilio rtc:apps:video:deploy --authentication passcode
7676
deploying app... done
77-
Passcode: 1111111111`,
77+
Passcode: xxx xxx xxxx xxxx
78+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
79+
Room Type: group`,
7880
`
7981
# Deploy an application token server with the React app
8082
$ twilio rtc:apps:video:deploy --authentication passcode --app-directory /path/to/app
8183
deploying app... done
82-
Web App URL: https://video-app-1111-dev.twil.io?passcode=1111111111
83-
Passcode: 1111111111`,
84+
Web App URL: https://video-app-1111-dev.twil.io?passcode=xxxxxxxxxxxxxx
85+
Passcode: xxx xxx xxxx xxxx
86+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
87+
Room Type: group`,
8488
`
8589
# Override an existing app with a fresh deployment
8690
# Please note that this will remove a previously deployed web application if no
8791
# app directory is provided
8892
$ twilio rtc:apps:video:deploy --authentication passcode --override
89-
Removed app with Passcode: 1111111111
93+
Removed app with Passcode: xxx xxx xxxx xxxx
9094
deploying app... done
91-
Passcode: 2222222222
92-
Expires: Mon Mar 09 2020 16:36:23 GMT-0600`,
95+
Passcode: yyy yyy yyyy yyyy
96+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
97+
Room Type: group`,
98+
`
99+
# Deploy an application token server with a specific room type
100+
$ twilio rtc:apps:video:deploy --authentication passcode --room-type peer-to-peer
101+
deploying app... done
102+
Passcode: xxx xxx xxxx xxxx
103+
Expires: Mon Mar 09 2020 16:36:23 GMT-0600
104+
Room Type: peer-to-peer`,
93105
];
94106

95107
module.exports = DeployCommand;

0 commit comments

Comments
 (0)