Skip to content

Commit e337f75

Browse files
committed
Missing docs for signal() methods
1 parent 2ff0953 commit e337f75

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

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

Lines changed: 21 additions & 0 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()) {

0 commit comments

Comments
 (0)