Skip to content

Commit a74fd10

Browse files
committed
Docs corrections
1 parent e337f75 commit a74fd10

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ public void forceDisconnect(String sessionId, String connectionId) throws OpenTo
666666

667667

668668
/**
669-
* 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.
670670
*
671671
* @param sessionId The session ID.
672672
* @param streamId The stream ID.
@@ -682,7 +682,7 @@ public Stream getStream(String sessionId, String streamId) throws OpenTokExcepti
682682
}
683683

684684
/**
685-
* 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.
686686
*
687687
* @param sessionId The session ID.
688688
*
@@ -700,11 +700,18 @@ public StreamList listStreams(String sessionId) throws OpenTokException {
700700
}
701701

702702
/**
703-
* Gets a list of {@link Stream} object for the given session ID.
703+
* Dials a SIP gateway to connect it an OpenTok session.
704704
*
705705
* @param sessionId The session ID.
706-
* @param token The token.
707-
* @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+
*
708715
* @return The {@link Sip} object.
709716
*/
710717
public Sip dial(String sessionId, String token, SipProperties properties) throws OpenTokException {

0 commit comments

Comments
 (0)