|
37 | 37 | import org.xml.sax.InputSource;
|
38 | 38 |
|
39 | 39 | /**
|
40 |
| -* Contains methods for creating OpenTok sessions and generating tokens. |
| 40 | +* Contains methods for creating OpenTok sessions, generating tokens, and working with archives. |
41 | 41 | * <p>
|
42 | 42 | * To create a new OpenTokSDK object, call the OpenTokSDK constructor with your OpenTok API key
|
43 | 43 | * and the API secret from <a href="https://dashboard.tokbox.com">the OpenTok dashboard</a>. Do not publicly share
|
@@ -186,7 +186,7 @@ public String generateToken(String sessionId) throws OpenTokException {
|
186 | 186 | * Creates a new OpenTok session and returns the session ID, which uniquely identifies
|
187 | 187 | * the session.
|
188 | 188 | * <p>
|
189 |
| - * For example, when using the OpenTok JavaScript library, use the session ID when calling the |
| 189 | + * For example, when using the OpenTok.js library, use the session ID when calling the |
190 | 190 | * <a href="http://tokbox.com/opentok/libraries/client/js/reference/OT.html#initSession">
|
191 | 191 | * OT.initSession()</a> method (to initialize an OpenTok session).
|
192 | 192 | * <p>
|
@@ -233,9 +233,8 @@ public String generateToken(String sessionId) throws OpenTokException {
|
233 | 233 | * <li>A location hint for the location of the OpenTok server to use for the session.</li>
|
234 | 234 | * </ul>
|
235 | 235 | *
|
236 |
| - * @return A session ID for the new session. For example, when using the OpenTok JavaScript library, use this session ID |
237 |
| - * in JavaScript on the page that you serve to the client. The JavaScript will use this value when calling the |
238 |
| - * <code>connect()</code> method of the Session object (to connect a user to an OpenTok session). |
| 236 | + * @return A session ID for the new session. For example, when using the OpenTok.js library, use |
| 237 | + * this session ID when calling the <code>OT.initSession()</code> method. |
239 | 238 | */
|
240 | 239 | public Session createSession(SessionProperties properties) throws OpenTokException {
|
241 | 240 | Map<String, Collection<String>> params;
|
@@ -337,9 +336,11 @@ public List<Archive> listArchives() throws OpenTokException {
|
337 | 336 | * Returns a List of {@link Archive} objects, representing archives that are both
|
338 | 337 | * both completed and in-progress, for your API key.
|
339 | 338 | *
|
340 |
| - * @param offset The index offset of the first archive. 0 is offset of the most recently STARTED archive. |
341 |
| - * 1 is the offset of the archive that STARTED prior to the most recent archive. |
342 |
| - * @param count The number of archives to be returned. The maximum number of archives returned is 1000. |
| 339 | + * @param offset The index offset of the first archive. 0 is offset of the most recently started |
| 340 | + * archive. |
| 341 | + * 1 is the offset of the archive that started prior to the most recent archive. |
| 342 | + * @param count The number of archives to be returned. The maximum number of archives returned |
| 343 | + * is 1000. |
343 | 344 | * @return A List of {@link Archive} objects.
|
344 | 345 | */
|
345 | 346 | public List<Archive> listArchives(int offset, int count) throws OpenTokException {
|
@@ -414,9 +415,9 @@ public Archive stopArchive(String archiveId) throws OpenTokException {
|
414 | 415 | /**
|
415 | 416 | * Deletes an OpenTok archive.
|
416 | 417 | * <p>
|
417 |
| - * You can only delete an archive which has a status of "AVAILABLE" or "UPLOADED". Deleting an archive |
418 |
| - * removes its record from the list of archives. For an "AVAILABLE" archive, it also removes the archive |
419 |
| - * file, making it unavailable for download. |
| 418 | + * You can only delete an archive which has a status of "available" or "uploaded". Deleting an |
| 419 | + * archive removes its record from the list of archives. For an "available" archive, it also |
| 420 | + * removes the archive file, making it unavailable for download. |
420 | 421 | *
|
421 | 422 | * @param archiveId The archive ID of the archive you want to delete.
|
422 | 423 | */
|
|
0 commit comments