quickblox 2.15.1 → 2.15.2

package/src/modules/chat/qbDialog.js

@@ -14,7 +14,7 @@ function DialogProxy(service) {
  **/
 DialogProxy.prototype = {
     /**
-     * Retrieve list of dialogs. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Retrieve_list_of_dialogs More info.}
+     * Retrieve list of dialogs({@link https://docs.quickblox.com/docs/js-chat-dialogs#retrieve-list-of-dialogs read more}).
      * @memberof QB.chat.dialog
      * @param {Object} params - Some filters to get only chat dialogs you need.
      * @param {listDialogCallback} callback - The callback function.
@@ -22,8 +22,8 @@ DialogProxy.prototype = {
     list: function(params, callback) {
         /**
          * Callback for QB.chat.dialog.list().
-         * @param {Object} error - The error object
-         * @param {Object} resDialogs - the dialog list
+         * @param {Object} error - The error object.
+         * @param {Object} resDialogs - the dialog list.
          * @callback listDialogCallback
          * */
 
@@ -39,7 +39,7 @@ DialogProxy.prototype = {
     },
 
     /**
-     * Create new dialog. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Create_new_dialog More info.}
+     * Create new dialog({@link https://docs.quickblox.com/docs/js-chat-dialogs#create-dialog read more}).
      * @memberof QB.chat.dialog
      * @param {Object} params - Object of parameters.
      * @param {createDialogCallback} callback - The callback function.
@@ -47,8 +47,8 @@ DialogProxy.prototype = {
     create: function(params, callback) {
         /**
          * Callback for QB.chat.dialog.create().
-         * @param {Object} error - The error object
-         * @param {Object} createdDialog - the dialog object
+         * @param {Object} error - The error object.
+         * @param {Object} createdDialog - the dialog object.
          * @callback createDialogCallback
          * */
 
@@ -64,7 +64,7 @@ DialogProxy.prototype = {
     },
 
     /**
-     * Update group dialog. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Update_group_dialog More info.}
+     * Update group dialog({@link https://docs.quickblox.com/docs/js-chat-dialogs#update-dialog read more}).
      * @memberof QB.chat.dialog
      * @param {String} id - The dialog ID.
      * @param {Object} params - Object of parameters.
@@ -73,8 +73,8 @@ DialogProxy.prototype = {
     update: function(id, params, callback) {
         /**
          * Callback for QB.chat.dialog.update()
-         * @param {Object} error - The error object
-         * @param {Object} res - the dialog object
+         * @param {Object} error - The error object.
+         * @param {Object} res - the dialog object.
          * @callback updateDialogCallback
          * */
 
@@ -88,7 +88,7 @@ DialogProxy.prototype = {
     },
 
     /**
-     * Delete a dialog or dialogs. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Delete_dialog More info.}
+     * Delete a dialog or dialogs({@link https://docs.quickblox.com/docs/js-chat-dialogs#delete-dialog read more}).
      * @memberof QB.chat.dialog
      * @param {Array} id - The dialog IDs array.
      * @param {Object | function} params_or_callback - Object of parameters or callback function.
@@ -96,8 +96,8 @@ DialogProxy.prototype = {
      * */
     delete: function(id, params_or_callback, callback) {
         /**
-         * Callback for QB.chat.dialog.delete()
-         * @param {Object} error - The error object
+         * Callback for QB.chat.dialog.delete().
+         * @param {Object} error - The error object.
          * @callback deleteDialogCallback
          * */
 

package/src/modules/chat/qbMessage.js

@@ -14,15 +14,15 @@ function MessageProxy(service) {
  **/
 MessageProxy.prototype = {
     /**
-     * get a chat history. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#List_chat_messages More info.}
+     * Get a chat history({@link https://docs.quickblox.com/docs/js-chat-messaging#retrieve-chat-history read more}).
      * @memberof QB.chat.message
      * @param {Object} params - Object of parameters.
      * @param {listMessageCallback} callback - The callback function.
      * */
     list: function(params, callback) {
         /**
-         * Callback for QB.chat.message.list()
-         * @param {Object} error - The error object
+         * Callback for QB.chat.message.list().
+         * @param {Object} error - The error object.
          * @param {Object} messages - The messages object.
          * @callback listMessageCallback
          * */
@@ -34,15 +34,15 @@ MessageProxy.prototype = {
     },
 
     /**
-     * Create message. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Put_chat_messages_to_history More info.}
+     * Create message.
      * @memberof QB.chat.message
      * @param {Object} params - Object of parameters.
      * @param {createMessageCallback} callback - The callback function.
      * */
     create: function(params, callback) {
         /**
-         * Callback for QB.chat.message.create()
-         * @param {Object} error - The error object
+         * Callback for QB.chat.message.create().
+         * @param {Object} error - The error object.
          * @param {Object} messages - The message object.
          * @callback createMessageCallback
          * */
@@ -55,19 +55,19 @@ MessageProxy.prototype = {
     },
 
     /**
-     * Update message. {@link https://docsdev.quickblox.com/rest_api/Chat_API.html#Update_message More info.}
+     * Update message({@link https://docs.quickblox.com/docs/js-chat-messaging#update-message read more}).
      * @memberof QB.chat.message
      * @param {String} id - The message id.
-     * @param {Object} params - Object of parameters
-     * @param {Number} [params.read] - Mark message as read (read=1)
-     * @param {Number} [params.delivered] - Mark message as delivered (delivered=1)
-     * @param {String} [params.message] - The message's text
-     * @param {updateMessageCallback} callback - The callback function
+     * @param {Object} params - Object of parameters.
+     * @param {Number} [params.read] - Mark message as read (read=1).
+     * @param {Number} [params.delivered] - Mark message as delivered (delivered=1).
+     * @param {String} [params.message] - The message's text.
+     * @param {updateMessageCallback} callback - The callback function.
      * */
     update: function(id, params, callback) {
         /**
-         * Callback for QB.chat.message.update()
-         * @param {Object} error - The error object
+         * Callback for QB.chat.message.update().
+         * @param {Object} error - The error object.
          * @param {Object} response - Empty body.
          * @callback updateMessageCallback
          * */
@@ -83,7 +83,7 @@ MessageProxy.prototype = {
     },
 
     /**
-     * Delete message. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Delete_chat_messages More info.}
+     * Delete message({@link https://docs.quickblox.com/docs/js-chat-messaging#delete-message read more}).
      * @memberof QB.chat.message
      * @param {String} id - The message id.
      * @param {Object} params - Object of parameters.
@@ -91,7 +91,7 @@ MessageProxy.prototype = {
      * */
     delete: function(id, params_or_callback, callback) {
         /**
-         * Callback for QB.chat.message.delete()
+         * Callback for QB.chat.message.delete().
          * @param {Object} error - The error object.
          * @param {String} res - Empty string.
          * @callback deleteMessageCallback
@@ -113,14 +113,14 @@ MessageProxy.prototype = {
     },
 
     /**
-     * Get unread messages counter for one or group of dialogs. {@link https://quickblox.com/developers/Web_XMPP_Chat_Sample#Unread_messages_count More info.}
+     * Get unread messages counter for one or group of dialogs({@link https://docs.quickblox.com/docs/js-chat-dialogs#get-number-of-unread-messages read more}).
      * @memberof QB.chat.message
      * @param {Object} params - Object of parameters.
      * @param {unreadCountMessageCallback} callback - The callback function.
      * */
     unreadCount: function(params, callback) {
         /**
-         * Callback for QB.chat.message.unreadCount()
+         * Callback for QB.chat.message.unreadCount().
          * @param {Object} error - The error object.
          * @param {Object} res - The requested dialogs Object.
          * @callback unreadCountMessageCallback

package/src/modules/qbAddressBook.js

@@ -16,7 +16,7 @@ AddressBook.prototype = {
    * The method is used to create, update and delete contacts in address book.<br />
    * If contact doesn't exist in address book then it will be created. If contacts exists then it will be updated.
    * If pass 'destroy: 1' then the contact will be removed.<br />
-   * {@link https://quickblox.com/developers/AddressBook Found more here}. <br />
+   * {@link https://docs.quickblox.com/docs/js-address-book#upload-address-book Found more here}. <br />
    * The method accepts 2 or 3 parameters.
    * @memberof QB.addressbook
    * @param {Object[]} list - A list of contacts to create / update / delete.
@@ -25,7 +25,7 @@ AddressBook.prototype = {
    * If not - it means a user has one global address book across all his devices.
    * @param {number} [options.force] - Defines force rewrite mode.
    * If set 1 then all previous contacts for device context will be replaced by new ones.
-   * @param {Function} callback - The savedAddressBookCallback function
+   * @param {Function} callback - The savedAddressBookCallback function.
    *
    * @example
    *  var people = [{
@@ -103,7 +103,7 @@ AddressBook.prototype = {
   },
 
   /**
-   * Retrive all contacts from address book.
+   * Retrive all contacts from address book({@link https://docs.quickblox.com/docs/js-address-book#retrieve-address-book read more}).
    * The method accepts 1 or 2 parameters.
    * @memberof QB.addressbook
    * @param {string|function} udidOrCallback - You could pass udid of address book or
@@ -166,7 +166,7 @@ AddressBook.prototype = {
   },
 
   /**
-   * Retrieve QuickBlox users that have phone numbers from your address book.
+   * Retrieve QuickBlox users that have phone numbers from your address book({@link https://docs.quickblox.com/docs/js-address-book#retrieve-registered-users read more}).
    * The methods accepts 1 or 2 parameters.
    * @memberof QB.addressbook
    * @param {boolean|function} udidOrCallback - You can pass isCompact parameter or callback object. If isCompact is passed then only user's id and phone fields will be returned from server. Otherwise - all standard user's fields will be returned.

package/src/modules/qbContent.js

@@ -28,19 +28,19 @@ function ContentProxy(service) {
 
 ContentProxy.prototype = {
     /**
-     * Get a list of files for current user ({@link https://docsdev.quickblox.com/rest_api/Content_API.html#Retrieve_files read more})
+     * Get a list of files for current user({@link https://docs.quickblox.com/docs/js-content#retrieve-files read more}).
      * @memberof QB.content
-     * @param {object} params - Object of parameters
-     * @param {number} [params.page=1] - Used to paginate the results when more than one page of files retrieved
-     * @param {number} [params.per_page=10] - The maximum number of files to return per page, if not specified then the default is 10
-     * @param {listOfFilesCallback} callback - The listOfFilesCallback function
+     * @param {object} params - Object of parameters.
+     * @param {number} [params.page=1] - Used to paginate the results when more than one page of files retrieved.
+     * @param {number} [params.per_page=10] - The maximum number of files to return per page, if not specified then the default is 10.
+     * @param {listOfFilesCallback} callback - The listOfFilesCallback function.
      */
     list: function(params, callback) {
         /**
-         * Callback for QB.content.list(params, callback)
+         * Callback for QB.content.list(params, callback).
          * @callback listOfFilesCallback
-         * @param {object} error - The error object
-         * @param {object} response - Object with Array of files
+         * @param {object} error - The error object.
+         * @param {object} response - Object with Array of files.
          */
         if (typeof params === 'function' && typeof callback === 'undefined') {
             callback = params;
@@ -57,21 +57,21 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Create new file object ({@link https://docsdev.quickblox.com/rest_api/Content_API.html#Create_file read more})
+     * Create new file object.
      * @private
      * @memberof QB.content
-     * @param {object} params - Object of parameters
-     * @param {string} params.content_type - The file's mime ({@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types content type})
-     * @param {string} params.name - The file's name
-     * @param {boolean} [params.public=false] - The file's visibility. public means it will be possible to access this file without QuickBlox session token provided. Default is 'false'
-     * @param {createFileCallback} callback - The createFileCallback function
+     * @param {object} params - Object of parameters.
+     * @param {string} params.content_type - The file's mime({@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types content type}).
+     * @param {string} params.name - The file's name.
+     * @param {boolean} [params.public=false] - The file's visibility. public means it will be possible to access this file without QuickBlox session token provided. Default is 'false'.
+     * @param {createFileCallback} callback - The createFileCallback function.
      */
     create: function(params, callback) {
         /**
-         * Callback for QB.content.create(params, callback)
+         * Callback for QB.content.create(params, callback).
          * @callback createFileCallback
-         * @param {object} error - The error object
-         * @param {object} response - The file object (blob-object-access)
+         * @param {object} error - The error object.
+         * @param {object} response - The file object (blob-object-access).
          */
         this.service.ajax({
             type: 'POST',
@@ -87,17 +87,17 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Delete file by id ({@link https://docsdev.quickblox.com/rest_api/Content_API.html#Delete_file read more})
+     * Delete file by id({@link https://docs.quickblox.com/docs/js-content#delete-file read more}).
      * @memberof QB.content
-     * @param {Number} id - blob_id
+     * @param {Number} id - blob_id.
      * @param {deleteFileCallback} callback - The deleteFileCallback function.
      */
     delete: function(id, callback) {
         /**
-         * Callback for QB.content.delete(id, callback)
+         * Callback for QB.content.delete(id, callback).
          * @callback deleteFileCallback
-         * @param {object} error - The error object
-         * @param {object} response - Boolean
+         * @param {object} error - The error object.
+         * @param {object} response - Boolean.
          */
         this.service.ajax({url: Utils.getUrl(config.urls.blobs, id), type: 'DELETE', dataType: 'text'}, function(err, result) {
             if (err) {
@@ -109,22 +109,22 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Create file > upload file > mark file as uploaded > return result.
+     * Create file > upload file > mark file as uploaded > return result({@link https://docs.quickblox.com/docs/js-content#upload-file read more}).
      * @memberof QB.content
-     * @param {object} params - Object of parameters
-     * @param {object} params.file - File object
-     * @param {string} params.name - The file's name
-     * @param {string} params.type - The file's mime ({@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types content type})
-     * @param {number} params.size - Size of file, in bytes
-     * @param {boolean} [params.public=false] - The file's visibility. public means it will be possible to access this file without QuickBlox session token provided. Default is 'false'
-     * @param {createAndUploadFileCallback} callback - The createAndUploadFileCallback function
+     * @param {object} params - Object of parameters.
+     * @param {object} params.file - File object.
+     * @param {string} params.name - The file's name.
+     * @param {string} params.type - The file's mime ({@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types content type}).
+     * @param {number} params.size - Size of file, in bytes.
+     * @param {boolean} [params.public=false] - The file's visibility. public means it will be possible to access this file without QuickBlox session token provided. Default is 'false'.
+     * @param {createAndUploadFileCallback} callback - The createAndUploadFileCallback function.
      */
     createAndUpload: function(params, callback) {
         /**
          * Callback for QB.content.createAndUpload(params, callback).
          * @callback createAndUploadFileCallback
-         * @param {object} error - The error object
-         * @param {object} response - The file object (blob-object-access)
+         * @param {object} error - The error object.
+         * @param {object} response - The file object (blob-object-access).
          */
         var _this = this,
             createParams= {},
@@ -197,20 +197,20 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Upload a file to cloud storage ({@link https://docsdev.quickblox.com/rest_api/Content_API.html#Upload_file read more})
+     * Upload a file to cloud storage.
      * @private
      * @memberof QB.content
-     * @param {Object} params - Object of parameters (see into source code of QB.content.createAndUpload(params, callback) to know how to prepare the params object)
-     * @param {string} params.url - location url
-     * @param {object} params.data - formed data with file
-     * @param {uploadFileCallback} callback - The uploadFileCallback function
+     * @param {Object} params - Object of parameters (see into source code of QB.content.createAndUpload(params, callback) to know how to prepare the params object).
+     * @param {string} params.url - File url.
+     * @param {object} params.data - Formed data with file.
+     * @param {uploadFileCallback} callback - The uploadFileCallback function.
      */
     upload: function(params, callback) {
         /**
-         * Callback for QB.content.upload(params, callback)
+         * Callback for QB.content.upload(params, callback).
          * @callback uploadFileCallback
-         * @param {object} error - The error object
-         * @param {object} response - The empty object
+         * @param {object} error - The error object.
+         * @param {object} response - The empty object.
          */
         var uploadParams = {
             type: 'POST',
@@ -230,20 +230,20 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Declare file uploaded. The file's 'status' field will be set to 'complete' ({@link https://docsdev.quickblox.com/rest_api/Content_API.html#Declare_file_uploaded read more})
+     * Declare file uploaded. The file's 'status' field will be set to 'complete'.
      * @private
      * @memberof QB.content
-     * @param {object} params - Object of parameters
-     * @param {number} params.blob_id - The id of file to declare as uploaded
-     * @param {number} params.size - Size of file, in bytes
-     * @param {markUploadedFileCallback} callback - The markUploadedFileCallback function
+     * @param {object} params - Object of parameters.
+     * @param {number} params.blob_id - The id of file to declare as uploaded.
+     * @param {number} params.size - Size of file, in bytes.
+     * @param {markUploadedFileCallback} callback - The markUploadedFileCallback function.
      */
     markUploaded: function (params, callback) {
         /**
-         * Callback for QB.content.markUploaded(params, callback)
+         * Callback for QB.content.markUploaded(params, callback).
          * @callback markUploadedFileCallback
-         * @param {object} error - The error object
-         * @param {object} response - The empty body
+         * @param {object} error - The error object.
+         * @param {object} response - The empty body.
          */
         this.service.ajax({
             url: Utils.getUrl(config.urls.blobs, params.id + '/complete'),
@@ -262,17 +262,17 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Retrieve file object by id (@link https://docsdev.quickblox.com/rest_api/Content_API.html#Retrieve_file read more})
+     * Retrieve file object info by id({@link https://docs.quickblox.com/docs/js-content#get-file-info read more}).
      * @memberof QB.content
-     * @param {number} id - The id of file to declare as uploaded
+     * @param {number} id - File object id.
      * @param {getFileInfoByIdCallback} callback - The getFileInfoByIdCallback function return file's object.
      */
     getInfo: function (id, callback) {
         /**
-         * Callback for QB.content.getInfo(id, callback)
+         * Callback for QB.content.getInfo(id, callback).
          * @callback getFileInfoByIdCallback
-         * @param {object} error - The error object
-         * @param {object} response - The file object (blob-object-access)
+         * @param {object} error - The error object.
+         * @param {object} response - The file object (blob-object-access).
          */
         this.service.ajax({url: Utils.getUrl(config.urls.blobs, id)}, function (err, res) {
             if (err) {
@@ -284,17 +284,17 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Download file by UID. If the file is public then it's possible to download it without a session token (@link https://docsdev.quickblox.com/rest_api/Content_API.html#Download_file read more})
+     * Download file by UID. If the file is public then it's possible to download it without a session token({@link https://docs.quickblox.com/docs/js-content#download-file-by-uid read more}).
      * @memberof QB.content
-     * @param {String} uid - The uid of file to declare as uploaded
-     * @param {downloadFileByUIDCallback} callback - The downloadFileByUIDCallback function
+     * @param {String} uid - File object uid.
+     * @param {downloadFileByUIDCallback} callback - The downloadFileByUIDCallback function.
      */
     getFile: function (uid, callback) {
         /**
-         * Callback for QB.content.getFile(uid, callback)
+         * Callback for QB.content.getFile(uid, callback).
          * @callback downloadFileByUIDCallback
-         * @param {object} error - The error object
-         * @param {object} response - The file object
+         * @param {object} error - The error object.
+         * @param {object} response - The file object.
          */
         this.service.ajax({url: Utils.getUrl(config.urls.blobs, uid)}, function (err, res) {
             if (err) {
@@ -306,19 +306,19 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Edit a file by ID ({@link https://docsdev.quickblox.com/rest_api/Content_API.html#Download_file read more})
+     * Edit a file by ID({@link https://docs.quickblox.com/docs/js-content#update-file read more}).
      * @memberof QB.content
-     * @param {object} params - Object of parameters
-     * @param {number} params.id - The id of file to declare as uploaded
-     * @param {string} [params.name] - New file name
-     * @param {updateFileCallback} callback - The updateFileCallback function
+     * @param {object} params - Object of parameters.
+     * @param {number} params.id - File object id.
+     * @param {string} [params.name] - New file name.
+     * @param {updateFileCallback} callback - The updateFileCallback function.
      */
     update: function (params, callback) {
         /**
-         * Callback for QB.content.update(uid, callback)
+         * Callback for QB.content.update(uid, callback).
          * @callback updateFileCallback
-         * @param {object} error - The error object
-         * @param {object} response - The file object (blob-object-access)
+         * @param {object} error - The error object.
+         * @param {object} response - The file object (blob-object-access).
          */
         var data = {};
 
@@ -338,18 +338,18 @@ ContentProxy.prototype = {
     },
 
     /**
-     * Get private URL for file download by file_uid (blob_uid).
+     * Get private URL for file download by file_uid (blob_uid) ({@link https://docs.quickblox.com/docs/js-content#get-private-url read more}).
      * @memberof QB.content
-     * @param {String} fileUID - The uid of file to declare as uploaded
+     * @param {String} fileUID - File object id.
      */
     privateUrl: function (fileUID) {
         return "https://" + config.endpoints.api + "/blobs/" + fileUID + "?token=" + this.service.getSession().token;
     },
 
     /**
-     * Get public URL for file download by file_uid (blob_uid).
+     * Get public URL for file download by file_uid (blob_uid) ({@link https://docs.quickblox.com/docs/js-content#get-public-url read more}).
      * @memberof QB.content
-     * @param {String} fileUID - The uid of file to declare as uploaded
+     * @param {String} fileUID - File object id.
      */
     publicUrl: function (fileUID) {
         return "https://" + config.endpoints.api + "/blobs/" + fileUID;