Skip to content

Commit accd818

Browse files
aoberoiaoberoi
committed
Merge branch 'jeffswartz-v2.2-docs' into aoberoi-modernization
Conflicts: src/main/java/com/opentok/TokenOptions.java
2 parents 1d5e185 + 6cf423d commit accd818

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+7189
-187
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
*.class
2+
*.DS_Store
23

34
# Package Files
45
*.jar

‎README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,8 @@ List<Archive> archives = opentok.listArchives(50, 50);
171171

172172
# Documentation
173173

174-
**TODO**: Reference documentation is available at <http://opentok.github.io/opentok-java-sdk/>
174+
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.
175176

176177
# Requirements
177178

@@ -185,11 +186,22 @@ This project is tested on both OpenJDK and Oracle implementations.
185186
**TODO**: See the [Releases](https://github.com/opentok/opentok-java-sdk/releases) page for details
186187
about each release.
187188

188-
## Important changes in v2.0
189+
## Important changes in v2.2
189190

190191
This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
191192
work with OpenTok 1.0 archives.)
192193

194+
This version of the SDK includes a number of improvements in the API design. These include a number
195+
of API changes. See the OpenTok 2.2 SDK Reference for details on the new API.
196+
197+
The API_Config class has been removed. Store your OpenTok API key and API secret in code outside of the SDK files.
198+
199+
The `create_session()` method has been renamed `createSession()`. Also, the method has changed to
200+
take one parameter: a SessionProperties object. You now generate a SessionProperties object using a Builder pattern.
201+
202+
The `generate_token()` method has been renamed `generateToken()`. Also, the method has changed to
203+
take two parameters: the session ID and a TokenOptions object.
204+
193205
# Development and Contributing
194206

195207
Interested in contributing? We :heart: pull requests! See the [Development](DEVELOPING.md) and

‎docs/allclasses-frame.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
6+
<title>All Classes (OpenTok 2.2 Java SDK)</title>
7+
<meta name="date" content="2014-05-13">
8+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
</head>
10+
<body>
11+
<h1 class="bar">All Classes</h1>
12+
<div class="indexContainer">
13+
<ul>
14+
<li><a href="com/opentok/Archive.html" title="class in com.opentok" target="classFrame">Archive</a></li>
15+
<li><a href="com/opentok/Archive.Status.html" title="enum in com.opentok" target="classFrame">Archive.Status</a></li>
16+
<li><a href="com/opentok/exception/InvalidArgumentException.html" title="class in com.opentok.exception" target="classFrame">InvalidArgumentException</a></li>
17+
<li><a href="com/opentok/OpenTok.html" title="class in com.opentok" target="classFrame">OpenTok</a></li>
18+
<li><a href="com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception" target="classFrame">OpenTokException</a></li>
19+
<li><a href="com/opentok/exception/RequestException.html" title="class in com.opentok.exception" target="classFrame">RequestException</a></li>
20+
<li><a href="com/opentok/Role.html" title="enum in com.opentok" target="classFrame">Role</a></li>
21+
<li><a href="com/opentok/Session.html" title="class in com.opentok" target="classFrame">Session</a></li>
22+
<li><a href="com/opentok/SessionProperties.html" title="class in com.opentok" target="classFrame">SessionProperties</a></li>
23+
<li><a href="com/opentok/SessionProperties.Builder.html" title="class in com.opentok" target="classFrame">SessionProperties.Builder</a></li>
24+
<li><a href="com/opentok/TokenOptions.html" title="class in com.opentok" target="classFrame">TokenOptions</a></li>
25+
<li><a href="com/opentok/TokenOptions.Builder.html" title="class in com.opentok" target="classFrame">TokenOptions.Builder</a></li>
26+
</ul>
27+
</div>
28+
</body>
29+
</html>

‎docs/allclasses-noframe.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
6+
<title>All Classes (OpenTok 2.2 Java SDK)</title>
7+
<meta name="date" content="2014-05-13">
8+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9+
</head>
10+
<body>
11+
<h1 class="bar">All Classes</h1>
12+
<div class="indexContainer">
13+
<ul>
14+
<li><a href="com/opentok/Archive.html" title="class in com.opentok">Archive</a></li>
15+
<li><a href="com/opentok/Archive.Status.html" title="enum in com.opentok">Archive.Status</a></li>
16+
<li><a href="com/opentok/exception/InvalidArgumentException.html" title="class in com.opentok.exception">InvalidArgumentException</a></li>
17+
<li><a href="com/opentok/OpenTok.html" title="class in com.opentok">OpenTok</a></li>
18+
<li><a href="com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></li>
19+
<li><a href="com/opentok/exception/RequestException.html" title="class in com.opentok.exception">RequestException</a></li>
20+
<li><a href="com/opentok/Role.html" title="enum in com.opentok">Role</a></li>
21+
<li><a href="com/opentok/Session.html" title="class in com.opentok">Session</a></li>
22+
<li><a href="com/opentok/SessionProperties.html" title="class in com.opentok">SessionProperties</a></li>
23+
<li><a href="com/opentok/SessionProperties.Builder.html" title="class in com.opentok">SessionProperties.Builder</a></li>
24+
<li><a href="com/opentok/TokenOptions.html" title="class in com.opentok">TokenOptions</a></li>
25+
<li><a href="com/opentok/TokenOptions.Builder.html" title="class in com.opentok">TokenOptions.Builder</a></li>
26+
</ul>
27+
</div>
28+
</body>
29+
</html>

0 commit comments

Comments
 (0)