@@ -300,6 +300,16 @@ public Session createSession() throws OpenTokException {
300
300
return createSession (null );
301
301
}
302
302
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
+ */
303
313
public void signal (String sessionId , SignalProperties props ) throws OpenTokException , RequestException , InvalidArgumentException {
304
314
305
315
if (sessionId == null || sessionId .isEmpty () ) {
@@ -315,6 +325,17 @@ public void signal(String sessionId, SignalProperties props) throws OpenTokExcep
315
325
316
326
}
317
327
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
+ */
318
339
public void signal (String sessionId , String connectionId , SignalProperties props ) throws OpenTokException , RequestException , InvalidArgumentException {
319
340
320
341
if (sessionId == null || sessionId .isEmpty () || connectionId == null || connectionId .isEmpty ()) {
@@ -645,7 +666,7 @@ public void forceDisconnect(String sessionId, String connectionId) throws OpenTo
645
666
646
667
647
668
/**
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 .
649
670
*
650
671
* @param sessionId The session ID.
651
672
* @param streamId The stream ID.
@@ -661,7 +682,7 @@ public Stream getStream(String sessionId, String streamId) throws OpenTokExcepti
661
682
}
662
683
663
684
/**
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.
665
686
*
666
687
* @param sessionId The session ID.
667
688
*
@@ -679,11 +700,18 @@ public StreamList listStreams(String sessionId) throws OpenTokException {
679
700
}
680
701
681
702
/**
682
- * Gets a list of {@link Stream} object for the given session ID .
703
+ * Dials a SIP gateway to connect it an OpenTok session.
683
704
*
684
705
* @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
+ *
687
715
* @return The {@link Sip} object.
688
716
*/
689
717
public Sip dial (String sessionId , String token , SipProperties properties ) throws OpenTokException {
0 commit comments