diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java index ca51e7f5..da194f85 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java @@ -52,7 +52,7 @@ public class Connection { /** * Returns the identifier of the Connection. You can call methods * {@link io.openvidu.java.client.Session#forceDisconnect(String)} or - * {@link io.openvidu.java.client.Session#updateConnection(String, TokenOptions)} + * {@link io.openvidu.java.client.Session#updateConnection(String, ConnectionProperties)} * passing this property as parameter */ public String getConnectionId() { @@ -190,7 +190,11 @@ public class Connection { } /** - * Returns the token string associated to the Connection + * Returns the token string associated to the Connection. This is the value that + * must be sent to the client-side to be consumed in OpenVidu Browser method + * Session.connect. */ public String getToken() { return this.token; diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java index dd5b77cd..b68504c3 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java @@ -78,8 +78,8 @@ public class ConnectionProperties { * {@link io.openvidu.java.client.ConnectionProperties.Builder#networkCache(int) * networkCache} * - * If not set by default will be @link - * io.openvidu.java.client.ConnectionType#WEBRTC}. + * If not set by default will be + * {@link io.openvidu.java.client.ConnectionType#WEBRTC}. */ public Builder type(ConnectionType type) { this.type = type; diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/Session.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/Session.java index bb6cf846..ccf65b2f 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/Session.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/Session.java @@ -155,7 +155,7 @@ public class Session { /** * Same as - * {@link io.openvidu.java.client.Session#createConnection(ConnectionProperties) + * {@link io.openvidu.java.client.Session#createConnection(ConnectionProperties)} * but with default ConnectionProperties values. * * @return The generated {@link io.openvidu.java.client.Connection Connection} diff --git a/openvidu-node-client/src/Connection.ts b/openvidu-node-client/src/Connection.ts index 3507fe72b..bf774c81 100644 --- a/openvidu-node-client/src/Connection.ts +++ b/openvidu-node-client/src/Connection.ts @@ -76,7 +76,8 @@ export class Connection { connectionProperties: ConnectionProperties; /** - * Token associated to the Connection + * Token associated to the Connection. This is the value that must be sent to the client-side to be consumed in OpenVidu Browser + * method [Session.connect](https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect). */ token: string; diff --git a/openvidu-node-client/src/OpenVidu.ts b/openvidu-node-client/src/OpenVidu.ts index b98a2ee1..463a91c9 100644 --- a/openvidu-node-client/src/OpenVidu.ts +++ b/openvidu-node-client/src/OpenVidu.ts @@ -17,13 +17,11 @@ import axios from 'axios'; import { Connection } from './Connection'; -import { Publisher } from './Publisher'; import { Recording } from './Recording'; import { RecordingProperties } from './RecordingProperties'; import { Session } from './Session'; import { SessionProperties } from './SessionProperties'; import { RecordingLayout } from './RecordingLayout'; -import { RecordingMode } from 'RecordingMode'; /** * @hidden @@ -90,17 +88,18 @@ export class OpenVidu { activeSessions: Session[] = []; /** - * @param urlOpenViduServer URL where your instance of OpenVidu Server is up an running. - * It must be the full URL (e.g. `https://12.34.56.78:1234/`) + * @param hostname URL where your instance of OpenVidu Server is up an running. + * It must be the full URL (e.g. `https://12.34.56.78:1234/`) + * * @param secret Secret used on OpenVidu Server initialization */ - constructor(private urlOpenViduServer: string, secret: string) { + constructor(private hostname: string, secret: string) { this.setHostnameAndPort(); this.basicAuth = this.getBasicAuth(secret); } /** - * Creates an OpenVidu session. You can call [[Session.getSessionId]] inside the resolved promise to retrieve the `sessionId` + * Creates an OpenVidu session. The session identifier will be available at property [[Session.sessionId]] * * @returns A Promise that is resolved to the [[Session]] if success and rejected with an Error object if not. */ @@ -669,7 +668,7 @@ export class OpenVidu { private setHostnameAndPort(): void { let url: URL; try { - url = new URL(this.urlOpenViduServer); + url = new URL(this.hostname); } catch (error) { console.error('URL format incorrect', error); throw new Error('URL format incorrect: ' + error); diff --git a/openvidu-node-client/src/Session.ts b/openvidu-node-client/src/Session.ts index 2d86dfaa..3f92a1e8 100644 --- a/openvidu-node-client/src/Session.ts +++ b/openvidu-node-client/src/Session.ts @@ -96,13 +96,6 @@ export class Session { this.properties.defaultRecordingLayout = !!this.properties.defaultRecordingLayout ? this.properties.defaultRecordingLayout : RecordingLayout.BEST_FIT; } - /** - * Gets the unique identifier of the Session - */ - public getSessionId(): string { - return this.sessionId; - } - /** * @deprecated Use [[Session.createConnection]] instead to get a [[Connection]] object. * @@ -401,7 +394,7 @@ export class Session { * [[Session.fetch]] or [[OpenVidu.fetch]] to see the changes consequence of the execution of this method applied in the local objects. * * The affected client will trigger one [ConnectionPropertyChangedEvent](/en/stable/api/openvidu-browser/classes/connectionpropertychangedevent.html) - * for each modified property. + * for each modified property. * * @param connectionId The [[Connection.connectionId]] of the Connection object to modify * @param connectionProperties A new [[ConnectionProperties]] object with the updated values to apply @@ -449,6 +442,13 @@ export class Session { }); } + /** + * @hidden + */ + public getSessionId(): string { + return this.sessionId; + } + /** * @hidden */ diff --git a/openvidu-server/src/main/java/io/openvidu/server/OpenViduServer.java b/openvidu-server/src/main/java/io/openvidu/server/OpenViduServer.java index 419d6e77..92964b48 100644 --- a/openvidu-server/src/main/java/io/openvidu/server/OpenViduServer.java +++ b/openvidu-server/src/main/java/io/openvidu/server/OpenViduServer.java @@ -347,11 +347,11 @@ public class OpenViduServer implements JsonRpcConfigurer { @EventListener(ApplicationReadyEvent.class) public void whenReady() { - String dashboardUrl = httpUrl + "dashboard/"; + String dashboardUrl = httpUrl + config.getOpenViduFrontendDefaultPath().replaceAll("^/", ""); // @formatter:off String msg = "\n\n----------------------------------------------------\n" + "\n" + " OpenVidu is ready!\n" - + " ---------------------------\n" + "\n" + " * OpenVidu Server: " + httpUrl + "\n" + "\n" + + " ---------------------------\n" + "\n" + " * OpenVidu Server URL: " + httpUrl + "\n" + "\n" + " * OpenVidu Dashboard: " + dashboardUrl + "\n" + "\n" + "----------------------------------------------------\n"; // @formatter:on