quickblox 2.15.1 → 2.15.2

package/src/modules/qbUsers.js

@@ -25,21 +25,21 @@ function UsersProxy(service) {
 UsersProxy.prototype = {
 
     /**
-     * Call this API to get a list of current users of you app. By default it returns upto 10 users, but you can change this by adding pagination parameters. You can filter the list of users by supplying a filter string. You can sort results by ask/desc ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_Users read more})
+     * Call this API to get a list of current users of you app. By default it returns upto 10 users, but you can change this by adding pagination parameters. You can filter the list of users by supplying a filter string. You can sort results by ask/desc({@link https://docs.quickblox.com/docs/js-users#retrieve-users read more}).
      * @memberof QB.users
-     * @param {object} params - Object of parameters
-     * @param {number} [params.page=1] - Used to paginate the results when more than one page of users retrieved
-     * @param {number} [params.per_page=10] - The maximum number of users to return per page, if not specified then the default is 10
-     * @param {string} [params.filter] - You can filter the list of users by supplying a {@link https://quickblox.com/developers/Users#Filters filter string}. Possible operators: gt, lt, ge, le, eq, ne, between, in. Allowed fields' types: string,number,date. Allowed fields: id, full_name, email, login, phone, website, created_at, updated_at, last_request_at, external_user_id, twitter_id, twitter_digits_id, facebook_id (example: 'field_type+field_name+operator+value')
-     * @param {string} [params.order] - Parameter to sort results. Possible values: asc and desc. Allowed fields' types: string,number,date. Allowed fields: id, full_name, email, login, phone, website, created_at, updated_at, last_request_at, external_user_id, twitter_id, twitter_digits_id, facebook_id ('asc+date+created_at' (format is 'sort_type+field_type+field_name'))
-     * @param {listUsersCallback} callback - The listUsersCallback function
+     * @param {object} params - Object of parameters.
+     * @param {number} [params.page=1] - Used to paginate the results when more than one page of users retrieved.
+     * @param {number} [params.per_page=10] - The maximum number of users to return per page, if not specified then the default is 10.
+     * @param {string} [params.filter] - You can filter the list of users by supplying a {@link https://docs.quickblox.com/docs/js-users#search-operators filter string}. Possible operators: gt, lt, ge, le, eq, ne, between, in. Allowed fields' types: string,number,date. Allowed fields: id, full_name, email, login, phone, website, created_at, updated_at, last_request_at, external_user_id, twitter_id, twitter_digits_id, facebook_id (example: 'field_type+field_name+operator+value').
+     * @param {string} [params.order] - Parameter to sort results. Possible values: asc and desc. Allowed fields' types: string,number,date. Allowed fields: id, full_name, email, login, phone, website, created_at, updated_at, last_request_at, external_user_id, twitter_id, twitter_digits_id, facebook_id ('asc+date+created_at' (format is 'sort_type+field_type+field_name')).
+     * @param {listUsersCallback} callback - The listUsersCallback function.
      */
     listUsers: function(params, callback) {
         /**
-         * Callback for QB.users.listUsers(params, callback)
+         * Callback for QB.users.listUsers(params, callback).
          * @callback listUsersCallback
-         * @param {object} error - The error object
-         * @param {object} response - Object with Array of users
+         * @param {object} error - The error object.
+         * @param {object} response - Object with Array of users.
          */
         var message = {}, filters = [], item;
 
@@ -78,20 +78,20 @@ UsersProxy.prototype = {
     },
 
     /**
-     * Retrieve a specific user or users
+     * Retrieve a specific user or users.
      * @memberof QB.users
-     * @param {(number|object)} params - {@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_by_id User ID} (number) or object of parameters (object with one of next required properties)
-     * @param {string} params.login - The login of the user to be retrieved ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_by_login read more})
-     * @param {string} params.full_name - The full name of users to be retrieved ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_by_full_name read more})
-     * @param {string} params.facebook_id - The user's facebook uid ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_by_Facebook_id read more})
-     * @param {string} params.twitter_id - The user's twitter uid ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_by_Twitter_id read more})
-     * @param {string} params.phone - The user's phone number
-     * @param {string} params.email - The user's email address ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_by_email read more})
-     * @param {(string|string[])} params.tags - A comma separated list of tags associated with users ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_users_by_tags read more})
-     * @param {(number|string)} params.external - An uid that represents the user in an external user registry ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Retrieve_user_external_user_id read more})
-     * @param {string} [params.page=1] - Used to paginate the results when more than one page of users retrieved (can be used with get by 'full_name' or 'tags')
-     * @param {string} [params.per_page=10] - The maximum number of users to return per page, if not specified then the default is 10 (can be used with get by 'full_name' or 'tags')
-     * @param {getUsersCallback} callback - The getUsersCallback function
+     * @param {(number|object)} params - User ID (number) or object of parameters (object with one of next required properties).
+     * @param {string} params.login - The login of the user to be retrieved({@link https://docs.quickblox.com/docs/js-users#retrieve-user-by-login read more}).
+     * @param {string} params.full_name - The full name of users to be retrieved({@link https://docs.quickblox.com/docs/js-users#retrieve-users-by-full-name read more}).
+     * @param {string} params.facebook_id - The user's facebook uid.
+     * @param {string} params.twitter_id - The user's twitter uid.
+     * @param {string} params.phone - The user's phone number({@link https://docs.quickblox.com/docs/js-users#retrieve-users-by-phone-number read more}).
+     * @param {string} params.email - The user's email address({@link https://docs.quickblox.com/docs/js-users#retrieve-user-by-email read more}).
+     * @param {(string|string[])} params.tags - A comma separated list of tags associated with users({@link https://docs.quickblox.com/docs/js-users#retrieve-users-by-tags read more}).
+     * @param {(number|string)} params.external - An uid that represents the user in an external user registry({@link https://docs.quickblox.com/docs/js-users#retrieve-user-by-external-user-id read more}).
+     * @param {string} [params.page=1] - Used to paginate the results when more than one page of users retrieved (can be used with get by 'full_name' or 'tags').
+     * @param {string} [params.per_page=10] - The maximum number of users to return per page, if not specified then the default is 10 (can be used with get by 'full_name' or 'tags').
+     * @param {getUsersCallback} callback - The getUsersCallback function.
      * @example
      * var params = {'email': 'example-email@gmail.com'};
      *
@@ -116,10 +116,10 @@ UsersProxy.prototype = {
      */
     get: function(params, callback) {
         /**
-         * Callback for QB.users.get(params, callback)
+         * Callback for QB.users.get(params, callback).
          * @callback getUsersCallback
-         * @param {object} error - The error object
-         * @param {object} response - The user object or object with Array of users
+         * @param {object} error - The error object.
+         * @param {object} response - The user object or object with Array of users.
          */
         var url;
 
@@ -158,29 +158,29 @@ UsersProxy.prototype = {
     },
 
     /**
-     * Registers a new app user. Call this API to register a user for the app. You must provide either a user login or email address along with their password, passing both email address and login is permitted but not required ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Sign_Up read more})
+     * Registers a new app user. Call this API to register a user for the app. You must provide either a user login or email address along with their password, passing both email address and login is permitted but not required({@link https://docs.quickblox.com/docs/js-users#create-user read more}).
      * @memberof QB.users
-     * @param {object} params - object of user's parameters
-     * @param {string} params.login - The user's login name
-     * @param {string} params.password - The user's password for this app
-     * @param {string} params.email - The user's email address
-     * @param {string} [params.full_name] - The user's full name
-     * @param {string} [params.phone] - The user's phone number
-     * @param {string} [params.website] - The user's web address, or other url
-     * @param {string} [params.facebook_id] - The user's facebook uid
-     * @param {string} [params.twitter_id] - The user's twitter uid
-     * @param {number} [params.blob_id] - The id of an associated blob for this user, for example their photo
-     * @param {(number|string)} [params.external_user_id] - An uid that represents the user in an external user registry
-     * @param {(string|string[])} [params.tag_list] - A comma separated list of tags associated with the user. Set up user tags and address them separately in your app
-     * @param {string} [params.custom_data] - The user's additional info
-     * @param {createUserCallback} callback - The createUserCallback function
+     * @param {object} params - Object of user's parameters.
+     * @param {string} params.login - The user's login name.
+     * @param {string} params.password - The user's password for this app.
+     * @param {string} params.email - The user's email address.
+     * @param {string} [params.full_name] - The user's full name.
+     * @param {string} [params.phone] - The user's phone number.
+     * @param {string} [params.website] - The user's web address, or other url.
+     * @param {string} [params.facebook_id] - The user's facebook uid.
+     * @param {string} [params.twitter_id] - The user's twitter uid.
+     * @param {number} [params.blob_id] - The id of an associated blob for this user, for example their photo.
+     * @param {(number|string)} [params.external_user_id] - An uid that represents the user in an external user registry.
+     * @param {(string|string[])} [params.tag_list] - A comma separated list of tags associated with the user. Set up user tags and address them separately in your app.
+     * @param {string} [params.custom_data] - The user's additional info.
+     * @param {createUserCallback} callback - The createUserCallback function.
      */
     create: function(params, callback) {
         /**
-         * Callback for QB.users.create(params, callback)
+         * Callback for QB.users.create(params, callback).
          * @callback createUserCallback
-         * @param {object} error - The error object
-         * @param {object} response - The user object
+         * @param {object} error - The error object.
+         * @param {object} response - The user object.
          */
         this.service.ajax({url: Utils.getUrl(config.urls.users), type: 'POST', data: {user: params}},
             function(err, res) {
@@ -193,31 +193,31 @@ UsersProxy.prototype = {
     },
 
     /**
-     * Update current user. In normal usage, nobody except the user is allowed to modify their own data. Any fields you don’t specify will remain unchanged, so you can update just a subset of the user’s data. login/email and password may be changed, but the new login/email must not already be in use ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Update_current_user read more})
+     * Update current user. In normal usage, nobody except the user is allowed to modify their own data. Any fields you don’t specify will remain unchanged, so you can update just a subset of the user’s data. login/email and password may be changed, but the new login/email must not already be in use({@link https://docs.quickblox.com/docs/js-users#update-user read more}).
      * @memberof QB.users
-     * @param {number} id - The id of user to update
-     * @param {object} params - object of user's parameters
-     * @param {string} [params.login] - The user's login name
-     * @param {string} [params.old_password] - The user's old password for this app
-     * @param {string} [params.password] - The user's new password for this app
-     * @param {string} [params.email] - The user's email address
-     * @param {string} [params.full_name] - The user's full name
-     * @param {string} [params.phone] - The user's phone number
-     * @param {string} [params.website] - The user's web address, or other url
-     * @param {string} [params.facebook_id] - The user's facebook uid
-     * @param {string} [params.twitter_id] - The user's twitter uid
-     * @param {number} [params.blob_id] - The id of an associated blob for this user, for example their photo
-     * @param {(number|string)} [params.external_user_id] - An uid that represents the user in an external user registry
-     * @param {(string|string[])} [params.tag_list] - A comma separated list of tags associated with the user. Set up user tags and address them separately in your app
-     * @param {string} [params.custom_data] - The user's additional info
-     * @param {updateUserCallback} callback - The updateUserCallback function
+     * @param {number} id - The id of user to update.
+     * @param {object} params - object of user's parameters.
+     * @param {string} [params.login] - The user's login name.
+     * @param {string} [params.old_password] - The user's old password for this app.
+     * @param {string} [params.password] - The user's new password for this app.
+     * @param {string} [params.email] - The user's email address.
+     * @param {string} [params.full_name] - The user's full name.
+     * @param {string} [params.phone] - The user's phone number.
+     * @param {string} [params.website] - The user's web address, or other url.
+     * @param {string} [params.facebook_id] - The user's facebook uid.
+     * @param {string} [params.twitter_id] - The user's twitter uid.
+     * @param {number} [params.blob_id] - The id of an associated blob for this user, for example their photo.
+     * @param {(number|string)} [params.external_user_id] - An uid that represents the user in an external user registry.
+     * @param {(string|string[])} [params.tag_list] - A comma separated list of tags associated with the user. Set up user tags and address them separately in your app.
+     * @param {string} [params.custom_data] - The user's additional info.
+     * @param {updateUserCallback} callback - The updateUserCallback function.
      */
     update: function(id, params, callback) {
         /**
-         * Callback for QB.users.update(id, params, callback)
+         * Callback for QB.users.update(id, params, callback).
          * @callback updateUserCallback
-         * @param {object} error - The error object
-         * @param {object} response - The user object
+         * @param {object} error - The error object.
+         * @param {object} response - The user object.
          */
         this.service.ajax({url: Utils.getUrl(config.urls.users, id), type: 'PUT', data: {user: params}},
             function(err, res) {
@@ -230,11 +230,11 @@ UsersProxy.prototype = {
     },
 
     /**
-     * Remove a user from the app, {@link https://docsdev.quickblox.com/rest_api/Users_API.html#Delete_user_by_id by user's id} or {@link https://docsdev.quickblox.com/rest_api/Users_API.html#Delete_user_by_external_user_id uid that represents the user in an external user registry}
+     * Remove a user from the app, {@linkhttps://docs.quickblox.com/docs/js-users#delete-user by user's id} or uid that represents the user in an external user registry.
      * @memberof QB.users
-     * @param {(number|object)} params - An id of user to remove or object with external user id
-     * @param {(number|string)} params.external - An id of user to remove or object with external user id
-     * @param {deleteUserCallback} callback - An uid that represents the user in an external user registry
+     * @param {(number|object)} params - An id of user to remove or object with external user id.
+     * @param {(number|string)} params.external - An id of user to remove or object with external user id.
+     * @param {deleteUserCallback} callback - An uid that represents the user in an external user registry.
      * @example
      * // parameter as user id:
      * var params = 567831;
@@ -252,10 +252,10 @@ UsersProxy.prototype = {
      */
     delete: function(params, callback) {
         /**
-         * Callback for QB.users.delete(params, callback)
+         * Callback for QB.users.delete(params, callback).
          * @callback deleteUserCallback
-         * @param {object} error - The error object
-         * @param {object} response - Empty body
+         * @param {object} error - The error object.
+         * @param {object} response - Empty body.
          */
         var url;
 
@@ -271,17 +271,17 @@ UsersProxy.prototype = {
     },
 
     /**
-     * You can initiate password resets for users who have emails associated with their account. Password reset instruction will be sent to this email address ({@link https://docsdev.quickblox.com/rest_api/Users_API.html#Password_reset read more})
+     * You can initiate password resets for users who have emails associated with their account. Password reset instruction will be sent to this email address({@link https://docs.quickblox.com/docs/js-users#reset-user-password read more}).
      * @memberof QB.users
-     * @param {string} email - The user's email to send reset password instruction
-     * @param {resetPasswordByEmailCallback} callback - The resetPasswordByEmailCallback function
+     * @param {string} email - The user's email to send reset password instruction.
+     * @param {resetPasswordByEmailCallback} callback - The resetPasswordByEmailCallback function.
      */
     resetPassword: function(email, callback) {
         /**
-         * Callback for QB.users.resetPassword(email, callback)
+         * Callback for QB.users.resetPassword(email, callback).
          * @callback resetPasswordByEmailCallback
-         * @param {object} error - The error object
-         * @param {object} response - Empty body
+         * @param {object} error - The error object.
+         * @param {object} response - Empty body.
          */
         this.service.ajax({url: Utils.getUrl(resetPasswordUrl), data: {email: email}, dataType: 'text'}, callback);
     }

package/src/modules/webrtc/qbRTCPeerConnection.js

@@ -10,6 +10,12 @@ var config = require('../../qbConfig');
 var Helpers = require('./qbWebRTCHelpers');
 
 /**
+ * @namespace QB.webrtc.RTCPeerConnection
+ */
+
+/**
+ * @function qbRTCPeerConnection
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {RTCConfiguration} [config]
  */
 var qbRTCPeerConnection = function qbRTCPeerConnection(config) {
@@ -103,7 +109,9 @@ qbRTCPeerConnection.prototype.negotiate = function () {
 };
 
 /**
- * Save remote SDP for future use
+ * Save remote SDP for future use.
+ * @function setRemoteSDP
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {RTCSessionDescriptionInit} newSDP 
  */
 qbRTCPeerConnection.prototype.setRemoteSDP = function (newSDP) {
@@ -115,7 +123,9 @@ qbRTCPeerConnection.prototype.setRemoteSDP = function (newSDP) {
 };
 
 /**
- * Returns SDP if it was set previously
+ * Returns SDP if it was set previously.
+ * @function getRemoteSDP
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @returns {RTCSessionDescriptionInit|undefined}
  */
 qbRTCPeerConnection.prototype.getRemoteSDP = function () {
@@ -123,7 +133,9 @@ qbRTCPeerConnection.prototype.getRemoteSDP = function () {
 };
 
 /**
- * Create offer or answer SDP and set as local description
+ * Create offer or answer SDP and set as local description.
+ * @function setLocalSessionDescription
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {Object} params
  * @param {'answer'|'offer'} params.type 
  * @param {RTCOfferOptions} [params.options] 
@@ -175,7 +187,9 @@ qbRTCPeerConnection.prototype.setLocalSessionDescription = function (params, cal
         });
     }
 
-    /** @param {RTCSessionDescriptionInit} description */
+    /** 
+     * @param {RTCSessionDescriptionInit} description 
+     */
     function successCallback(description) {
         var modifiedDescription = _removeExtmapMixedFromSDP(description);
         modifiedDescription.sdp = setPreferredCodec(
@@ -214,6 +228,9 @@ qbRTCPeerConnection.prototype.setLocalSessionDescription = function (params, cal
 };
 
 /**
+ * Set remote session description.
+ * @function setRemoteSessionDescription
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {RTCSessionDescriptionInit} description 
  * @param {Function} callback 
  * @returns {void}
@@ -238,6 +255,9 @@ qbRTCPeerConnection.prototype.setRemoteSessionDescription = function (
 };
 
 /**
+ * Add local stream.
+ * @function addLocalStream
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {MediaStream} stream
  */
 qbRTCPeerConnection.prototype.addLocalStream = function (stream) {
@@ -251,6 +271,9 @@ qbRTCPeerConnection.prototype.addLocalStream = function (stream) {
 };
 
 /**
+ * Add ice candidate.
+ * @function _addIceCandidate
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {RTCIceCandidateInit} iceCandidate 
  * @returns {Promise<void>}
  */
@@ -261,6 +284,9 @@ qbRTCPeerConnection.prototype._addIceCandidate = function (iceCandidate) {
 };
 
 /**
+ * Add ice candidates.
+ * @function addCandidates
+ * @memberOf QB.webrtc.RTCPeerConnection
  * @param {Array<RTCIceCandidateInit>} iceCandidates 
  */
 qbRTCPeerConnection.prototype.addCandidates = function (iceCandidates) {

package/src/modules/webrtc/qbWebRTCClient.js

@@ -5,6 +5,10 @@
  * WebRTC Module (WebRTC client)
  */
 
+/**
+ * @namespace QB.webrtc
+ */
+
 /*
  * User's callbacks (listener-functions):
  * - onCallListener(session, extension)
@@ -51,10 +55,12 @@ function WebRTCClient(service, chat) {
 }
 
 /**
- * [Return data or all active devices]
- * @param  {String} spec [specify what type of devices you wnat to get.
- *                         Possible values: audioinput, audiooutput, videoinput]
- * @returns {Array}       [array of devices]
+ * Return data or all active devices.
+ * @function getMediaDevices
+ * @memberof QB.webrtc
+ * @param  {String} spec - Specify what type of devices you wnat to get.
+ *                         Possible values: audioinput, audiooutput, videoinput.
+ * @returns {Array} Array of devices.
  */
 WebRTCClient.prototype.getMediaDevices = function(spec) {
     var specDevices = [],
@@ -84,17 +90,22 @@ WebRTCClient.prototype.getMediaDevices = function(spec) {
 
 /**
  * A map with all sessions the user had/have.
- * @type {Object.<string, Object>}
+ * @member {Object.<string, Object>} sessions
+ * @memberof QB.webrtc
  */
 WebRTCClient.prototype.sessions = {};
 
 /**
- * Creates the new session.
- * @param  {Array<number>} opponentsIDs      - Opponents IDs
- * @param  {1|2} ct               - Call type
- * @param  {number} [cID=yourUserId] - Initiator ID
+ * Creates the new session({@link https://docs.quickblox.com/docs/js-video-calling#create-session read more}).
+ * @function createNewSession
+ * @memberof QB.webrtc
+ * @param  {Array<number>} opponentsIDs - Opponents IDs.
+ * @param  {1|2} ct - Call type.
+ * @param  {number} [cID=yourUserId] - Initiator ID.
  * @param  {object} [opts]
- * @param  {number} [opts.bandwidth=0] - Bandwidth limit (kbps)
+ * @param  {number} [opts.bandwidth=0] - Bandwidth limit (kbps).
+ * 
+ * @returns {WebRTCSession} 
  */
 WebRTCClient.prototype.createNewSession = function(opponentsIDs, ct, cID, opts) {
     var opponentsIdNASessions = getOpponentsIdNASessions(this.sessions),
@@ -150,8 +161,10 @@ WebRTCClient.prototype._createAndStoreSession = function(sessionID, callerID, op
 };
 
 /**
- * Deletes a session
- * @param {string} Session ID
+ * Deletes a session.
+ * @function clearSession
+ * @memberof QB.webrtc
+ * @param {string} sessionId - Session id.
  *
  */
 WebRTCClient.prototype.clearSession = function(sessionId) {
@@ -159,9 +172,9 @@ WebRTCClient.prototype.clearSession = function(sessionId) {
 };
 
 /**
- * Check all session and find session with status 'NEW' or 'ACTIVE' which ID != provided
- * @param {string} session ID
- * @returns {boolean} if active or new session exist
+ * Check all session and find session with status 'NEW' or 'ACTIVE' which ID != provided.
+ * @param {string} sessionID - Session id.
+ * @returns {boolean} True if active or new session exist.
  */
 WebRTCClient.prototype.isExistLiveSessionExceptSessionID = function(sessionID) {
     var exist = false;