Skip to content

Commit 7b8d371

Browse files
committed
Docs corrections.
1 parent 4ff0f45 commit 7b8d371

File tree

4 files changed

+15
-14
lines changed

4 files changed

+15
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ List<Archive> archives = opentok.listArchives(50, 50);
172172
# Documentation
173173

174174
Reference documentation is available at <http://www.tokbox.com//opentok/libraries/server/java/reference/index.html> and in the
175-
docs directory of the SDK
175+
docs directory of the SDK.
176176

177177
# Requirements
178178

src/main/java/com/opentok/Archive.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public enum Status {
3535
*/
3636
STOPPED,
3737
/**
38-
* The archive file is available at the target S3 bucket you at the
38+
* The archive file is available at the target S3 bucket you set at the
3939
* <a href="https://dashboard.tokbox.com">OpenTok dashboard</a>.
4040
*/
4141
UPLOADED;

src/main/java/com/opentok/OpenTok.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
import org.xml.sax.InputSource;
3838

3939
/**
40-
* Contains methods for creating OpenTok sessions and generating tokens.
40+
* Contains methods for creating OpenTok sessions, generating tokens, and working with archives.
4141
* <p>
4242
* To create a new OpenTokSDK object, call the OpenTokSDK constructor with your OpenTok API key
4343
* 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 {
186186
* Creates a new OpenTok session and returns the session ID, which uniquely identifies
187187
* the session.
188188
* <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
190190
* <a href="http://tokbox.com/opentok/libraries/client/js/reference/OT.html#initSession">
191191
* OT.initSession()</a> method (to initialize an OpenTok session).
192192
* <p>
@@ -233,9 +233,8 @@ public String generateToken(String sessionId) throws OpenTokException {
233233
* <li>A location hint for the location of the OpenTok server to use for the session.</li>
234234
* </ul>
235235
*
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.
239238
*/
240239
public Session createSession(SessionProperties properties) throws OpenTokException {
241240
Map<String, Collection<String>> params;
@@ -337,9 +336,11 @@ public List<Archive> listArchives() throws OpenTokException {
337336
* Returns a List of {@link Archive} objects, representing archives that are both
338337
* both completed and in-progress, for your API key.
339338
*
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.
343344
* @return A List of {@link Archive} objects.
344345
*/
345346
public List<Archive> listArchives(int offset, int count) throws OpenTokException {
@@ -414,9 +415,9 @@ public Archive stopArchive(String archiveId) throws OpenTokException {
414415
/**
415416
* Deletes an OpenTok archive.
416417
* <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.
420421
*
421422
* @param archiveId The archive ID of the archive you want to delete.
422423
*/

src/main/java/com/opentok/Role.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public enum Role {
1616
SUBSCRIBER,
1717
/**
1818
* A publisher can publish streams, subscribe to streams, and signal. (This is the default
19-
* value if you do not set a roll by calling the {@link TokenOptions.Builder#role(Role role)}
19+
* value if you do not set a role by calling the {@link TokenOptions.Builder#role(Role role)}
2020
* method.
2121
*/
2222
PUBLISHER,

0 commit comments

Comments
 (0)