Skip to content

Commit 8f84d60

Browse files
authored
Merge pull request #211 from jeffswartz/misc-docs-edits
Some docs corrections
2 parents 5f7c9dc + a74fd10 commit 8f84d60

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

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

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,16 @@ public Session createSession() throws OpenTokException {
300300
return createSession(null);
301301
}
302302

303+
/**
304+
* Sends a signal to all clients connected to a session.
305+
*
306+
* <p>
307+
* For more information, see the
308+
* <a href="https://tokbox.com/developer/guides/signaling/">Signaling developer guide</a>.
309+
*
310+
* @param sessionId The session ID.
311+
* @param props The SignalProperties object that defines the data and type of the signal.
312+
*/
303313
public void signal(String sessionId, SignalProperties props) throws OpenTokException , RequestException, InvalidArgumentException {
304314

305315
if (sessionId == null || sessionId.isEmpty() ) {
@@ -315,6 +325,17 @@ public void signal(String sessionId, SignalProperties props) throws OpenTokExcep
315325

316326
}
317327

328+
/**
329+
* Sends a signal to a specific client connected to a session.
330+
*
331+
* <p>
332+
* For more information, see the
333+
* <a href="https://tokbox.com/developer/guides/signaling/">Signaling developer guide</a>.
334+
*
335+
* @param sessionId The session ID.
336+
* @param sessionId The connection ID of the client to receive the signal.
337+
* @param props The SignalProperties object that defines the data and type of the signal.
338+
*/
318339
public void signal(String sessionId, String connectionId, SignalProperties props) throws OpenTokException , RequestException , InvalidArgumentException {
319340

320341
if (sessionId == null || sessionId.isEmpty() || connectionId == null || connectionId.isEmpty()) {
@@ -645,7 +666,7 @@ public void forceDisconnect(String sessionId, String connectionId) throws OpenTo
645666

646667

647668
/**
648-
* Gets an {@link Stream} object for the given sessionId and streamId.
669+
* Gets a {@link Stream} object for the given session ID and stream ID.
649670
*
650671
* @param sessionId The session ID.
651672
* @param streamId The stream ID.
@@ -661,7 +682,7 @@ public Stream getStream(String sessionId, String streamId) throws OpenTokExcepti
661682
}
662683

663684
/**
664-
* Gets a list of {@link Stream} object for the given session ID.
685+
* Gets a list of {@link Stream} objects for the given session ID.
665686
*
666687
* @param sessionId The session ID.
667688
*
@@ -679,11 +700,18 @@ public StreamList listStreams(String sessionId) throws OpenTokException {
679700
}
680701

681702
/**
682-
* Gets a list of {@link Stream} object for the given session ID.
703+
* Dials a SIP gateway to connect it an OpenTok session.
683704
*
684705
* @param sessionId The session ID.
685-
* @param token The token.
686-
* @param properties The SipProperties.
706+
*
707+
* @param token OpenTok token to be used for the participant being called. You can add token
708+
* data to identify that the participant is on a SIP endpoint or for other identifying data,
709+
* such as phone numbers. (The OpenTok client libraries include properties for inspecting
710+
* the connection data for a client connected to a session.) See the
711+
* <a href="https://tokbox.com/developer/guides/signaling/">Token Creation developer guide</a>.
712+
. *
713+
* @param properties The {@link SipProperties} object defining options for the SIP call.
714+
*
687715
* @return The {@link Sip} object.
688716
*/
689717
public Sip dial(String sessionId, String token, SipProperties properties) throws OpenTokException {

0 commit comments

Comments
 (0)