diff --git a/openvidu-node-client/src/OpenVidu.ts b/openvidu-node-client/src/OpenVidu.ts index bcc511b6..2c52a4e7 100644 --- a/openvidu-node-client/src/OpenVidu.ts +++ b/openvidu-node-client/src/OpenVidu.ts @@ -100,7 +100,8 @@ export class OpenVidu { /** * 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. + * @returns A Promise that is resolved to the [[Session]] if success and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not. * This Error object has as `message` property with a status code carrying a specific meaning * (see [REST API](/en/stable/reference-docs/REST-API/#post-recording-start)). * @@ -133,8 +134,9 @@ export class OpenVidu { * @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`) * @param properties Custom RecordingProperties to apply to this Recording. This will override the global default values set to the Session with [[SessionProperties.defaultRecordingProperties]] * - * @returns A Promise that is resolved to the [[Recording]] if it successfully started (the recording can be stopped with guarantees) and rejected with an Error - * object if not. This Error object has as `message` property with a status code carrying a specific meaning + * @returns A Promise that is resolved to the [[Recording]] if it successfully started (the recording can be stopped with guarantees) and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not. + * This Error object has as `message` property with a status code carrying a specific meaning * (see [REST API](/en/stable/reference-docs/REST-API/#post-recording-start)). */ public startRecording(sessionId: string, param2?: string | RecordingProperties): Promise { @@ -209,7 +211,8 @@ export class OpenVidu { * * @param recordingId The `id` property of the [[Recording]] you want to stop * - * @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. + * @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not. * This Error object has as `message` property with a status code carrying a specific meaning * (see [REST API](/en/stable/reference-docs/REST-API/#post-recording-stop)). */ @@ -252,7 +255,8 @@ export class OpenVidu { * * @param recordingId The `id` property of the [[Recording]] you want to retrieve * - * @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. + * @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not. * This Error object has as `message` property with a status code carrying a specific meaning * (see [REST API](/en/stable/reference-docs/REST-API/#get-recording)). */ @@ -324,7 +328,8 @@ export class OpenVidu { * * @param recordingId * - * @returns A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. + * @returns A Promise that is resolved if the Recording was successfully deleted and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not. * This Error object has as `message` property with a status code carrying a specific meaning * (see [REST API](/en/stable/reference-docs/REST-API/#delete-recording)). */ diff --git a/openvidu-node-client/src/Session.ts b/openvidu-node-client/src/Session.ts index e840cc3f..1fd456ee 100644 --- a/openvidu-node-client/src/Session.ts +++ b/openvidu-node-client/src/Session.ts @@ -98,7 +98,8 @@ export class Session { /** * @deprecated Use [[Session.createConnection]] instead to get a [[Connection]] object. * - * @returns A Promise that is resolved to the generated _token_ string if success and rejected with an Error object if not + * @returns A Promise that is resolved to the generated _token_ string if success and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not */ public generateToken(tokenOptions?: TokenOptions): Promise { return new Promise((resolve, reject) => { @@ -137,7 +138,8 @@ export class Session { * `connectionProperties`. Each user connecting to the Session requires a Connection. * The token string value to send to the client side is available at [[Connection.token]]. * - * @returns A Promise that is resolved to the generated [[Connection]] object if success and rejected with an Error object if not + * @returns A Promise that is resolved to the generated [[Connection]] object if success and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not */ public createConnection(connectionProperties?: ConnectionProperties): Promise { return new Promise((resolve, reject) => { @@ -185,7 +187,8 @@ export class Session { /** * Gracefully closes the Session: unpublishes all streams and evicts every participant * - * @returns A Promise that is resolved if the session has been closed successfully and rejected with an Error object if not + * @returns A Promise that is resolved if the session has been closed successfully and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not */ public close(): Promise { return new Promise((resolve, reject) => { @@ -268,7 +271,8 @@ export class Session { * * @param connection The Connection object to remove from the session, or its `connectionId` property * - * @returns A Promise that is resolved if the Connection was successfully removed from the Session and rejected with an Error object if not + * @returns A Promise that is resolved if the Connection was successfully removed from the Session and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not */ public forceDisconnect(connection: string | Connection): Promise { return new Promise((resolve, reject) => { @@ -340,7 +344,8 @@ export class Session { * * @param publisher The Publisher object to unpublish, or its `streamId` property * - * @returns A Promise that is resolved if the stream was successfully unpublished and rejected with an Error object if not + * @returns A Promise that is resolved if the stream was successfully unpublished and rejected with an + * [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not */ public forceUnpublish(publisher: string | Publisher): Promise { return new Promise((resolve, reject) => { @@ -405,7 +410,7 @@ export class Session { * @param connectionProperties A new [[ConnectionProperties]] object with the updated values to apply * * @returns A Promise that is resolved to the updated [[Connection]] object if the operation was - * successful and rejected with an Error object if not + * successful and rejected with an [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object if not */ public updateConnection(connectionId: string, connectionProperties: ConnectionProperties): Promise { return new Promise((resolve, reject) => {