[
{
"comment": "/**\n * @module\n * @name FileStorage\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n * This service shares files with a single user (one-to-one conversation) or with several persons (bubble conversation).
\n * The main methods and events proposed in that service allow to:\n *\n * - Upload a file in a one-to-one conversation or bubble conversation,\n * - Download a file from a conversation or bubble,\n * - To be notified when a file has been successfully uploaded when there is an error when uploading or downloading a file in a conversation or a bubble.\n * - Get the list of files send or received in a one-to-one conversation\n * - Get the list of files send or received in a bubble conversation\n * - Get the connected user quota and consumption\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 79,
"columnno": 0,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"kind": "module",
"name": "FileStorage",
"version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z",
"access": "public",
"description": "This service shares files with a single user (one-to-one conversation) or with several persons (bubble conversation).
\n The main methods and events proposed in that service allow to:\n\n - Upload a file in a one-to-one conversation or bubble conversation,\n - Download a file from a conversation or bubble,\n - To be notified when a file has been successfully uploaded when there is an error when uploading or downloading a file in a conversation or a bubble.\n - Get the list of files send or received in a one-to-one conversation\n - Get the list of files send or received in a bubble conversation\n - Get the connected user quota and consumption",
"longname": "module:FileStorage",
"$longname": "FileStorage",
"$kind": "module"
},
{
"comment": "",
"meta": {
"range": [
3916,
4834
],
"filename": "FileStorageService.js",
"lineno": 101,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {
"id": "astnode100000476",
"name": "FileStorage_1",
"type": "MethodDefinition",
"paramnames": [
"_core",
"_eventEmitter",
"_logger",
"_startConfig"
]
},
"vars": {
"": null
}
},
"undocumented": true,
"name": "FileStorage_1",
"longname": "module:FileStorage.FileStorage_1",
"kind": "class",
"memberof": "module:FileStorage",
"scope": "static",
"params": [],
"$longname": "FileStorage.FileStorage_1",
"$kind": "constructor"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method copyFileInPersonalCloudSpace\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * This API allows to keep a copy in my personal cloud space. Then:\n * - A new file descriptor is created.\n * - The viewer becomes owner. The file has not yet viewer.\n * - A copy of the file is put in the viewer's personal cloud space.\n * - A STANZA MESSAGE (type management) is sent to the owner of this new file. (tag 'file', action='update')\n *\n * To copy the file you must:\n *\n * - have enough space to store the file.(errorDetailsCode: 403630)\n * - not be the owner of the file.(errorDetailsCode: 403631)\n * - be an allowed viewer. The file is shared via a conversation or via a room.(errorDetailsCode: 403632)\n * - copy a file uploaded.(errorDetailsCode: 403630)\n * - have a personal cloud space in the same data center than the owner of the file.\n *\n * @param {string} fileId [required] Identifier of file descriptor to modify\n * @return {Promise} File descriptor Object\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 2117,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "copyFileInPersonalCloudSpace",
"scope": "instance",
"description": "This API allows to keep a copy in my personal cloud space. Then:\n- A new file descriptor is created.\n- The viewer becomes owner. The file has not yet viewer.\n- A copy of the file is put in the viewer's personal cloud space.\n- A STANZA MESSAGE (type management) is sent to the owner of this new file. (tag 'file', action='update')\n\nTo copy the file you must:\n\n- have enough space to store the file.(errorDetailsCode: 403630)\n- not be the owner of the file.(errorDetailsCode: 403631)\n- be an allowed viewer. The file is shared via a conversation or via a room.(errorDetailsCode: 403632)\n- copy a file uploaded.(errorDetailsCode: 403630)\n- have a personal cloud space in the same data center than the owner of the file.",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "[required] Identifier of file descriptor to modify",
"name": "fileId"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "File descriptor Object"
}
],
"longname": "module:FileStorage#copyFileInPersonalCloudSpace",
"memberof": "module:FileStorage",
"$longname": "FileStorage#copyFileInPersonalCloudSpace",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.47.1\n * @nodered true\n * @method downloadFile\n * @category Files TRANSFER\n * @async\n * @instance\n * @param {FileDescriptor} fileDescriptor The description of the file to download (short file descriptor)\n * @description\n * Allow to download a file from the server
\n * Return a promise
\n * @return {} Object with : Array of buffer Binary data of the file type, Mime type, fileSize: fileSize, Size of the file , fileName: fileName The name of the file Return the file received\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 473,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.47.1",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "downloadFile",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"FileDescriptor"
]
},
"description": "The description of the file to download (short file descriptor)",
"name": "fileDescriptor"
}
],
"description": "Allow to download a file from the server
\n Return a promise
",
"returns": [
{
"description": "Object with : Array of buffer Binary data of the file type, Mime type, fileSize: fileSize, Size of the file , fileName: fileName The name of the file Return the file received"
}
],
"longname": "module:FileStorage#downloadFile",
"memberof": "module:FileStorage",
"$longname": "FileStorage#downloadFile",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.79.0\n * @nodered true\n * @method downloadFileInPath\n * @instance\n * @category Files TRANSFER\n * @async\n * @param {FileDescriptor} fileDescriptor The description of the file to download (short file descriptor)\n * @param {string} path If provided then the retrieved file is stored in it. If not provided then\n * @async\n * @description\n * Allow to download a file from the server and store it in provided path.
\n * Return a promise
\n * @return {Observable} Return an Observable object to see the completion of the download/save.
\n * It returns a percentage of downloaded data Values are between 0 and 100 (include).
\n * The last one value is the description and content of the file :
\n * {
\n * buffer : blobArray, // the buffer with the content of the file.
\n * type: mime, // The mime type of the encoded file
\n * fileSize: fileSize, // The size in octects of the file
\n * fileName: fileName // The file saved.
\n * }
\n * Warning !!! :
\n * take care to not log this last data which can be very important for big files. You can test if the value is < 101.
\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 522,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.79.0",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "downloadFileInPath",
"scope": "instance",
"async": true,
"params": [
{
"type": {
"names": [
"FileDescriptor"
]
},
"description": "The description of the file to download (short file descriptor)",
"name": "fileDescriptor"
},
{
"type": {
"names": [
"string"
]
},
"description": "If provided then the retrieved file is stored in it. If not provided then",
"name": "path"
}
],
"description": "Allow to download a file from the server and store it in provided path.
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Observable."
]
},
"description": "Return an Observable object to see the completion of the download/save.
\nIt returns a percentage of downloaded data Values are between 0 and 100 (include).
\nThe last one value is the description and content of the file :
\n {
\n buffer : blobArray, // the buffer with the content of the file.
\n type: mime, // The mime type of the encoded file
\n fileSize: fileSize, // The size in octects of the file
\n fileName: fileName // The file saved.
\n }
\n Warning !!! :
\n take care to not log this last data which can be very important for big files. You can test if the value is < 101.
"
}
],
"longname": "module:FileStorage#downloadFileInPath",
"memberof": "module:FileStorage",
"$longname": "FileStorage#downloadFileInPath",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method fileOwnershipChange\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * As a file owner, I want to Drop the ownership to another Rainbow user of the same company.
\n * Then:
\n *
\n * The former owner becomes a viewer to stay allowed to get the display of the file.
\n * The new owner may loose his status of viewer when needed (as he becomes owner).
\n *
\n * Error cases:\n *\n * - the former owner's company must allow file ownership change (forbidFileOwnerChangeCustomisation == disabled) errorDetailCode 403156 Access denied: this API can only be called by users having the feature key forbidFileOwnerChangeCustomisation disabled\n * - the logged in user is not the owner (errorDetailsCode: 403629)\n * - the new owner must belong to the same company of the current owner. errorDetailCode 403637 User [userId] doesn't belong to the company [companyId]\n * - the target file is not uploaded yet. errorDetailCode 403638 File [fileId] is not uploaded yet. So it can't be re-allocated.\n * - the new owner must have enough space to store the file.(errorDetailsCode: 403630)\n * - A STANZA MESSAGE (type management) is sent to the owner and each viewers. (tag 'file', action='update', owner='xxxxxxxxxxxxx')\n *\n * @param {string} fileId [required] Identifier of file descriptor to modify\n * @param {string} userId ID of another user which will become owner.\n * @return {Promise} File descriptor Object\n *\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | data | Object | File descriptor Object |\n * | id | String | File unique identifier (like 56d0277a0261b53142a5cab5) |\n * | fileName | String | Name of the file |\n * | ownerId | String | Rainbow Id of the file owner |\n * | md5sum | String | md5 of the file get from the backend file storage (default: \"\", refreshed each time the file is uploaded) |\n * | extension | String | File extension (jpeg, txt, ...) |\n * | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (image/jpeg,text/plain,...) |\n * | size | Number | Size of the file (Default: value given by Rainbow clients). Refreshed from the backend file storage each time the file is uploaded. |\n * | registrationDate | Date-Time | Date when the submit to upload this file was registered |\n * | isUploaded | Boolean | true when the file was uploaded at least one time |\n * | uploadedDate | Date-Time | Last time when the file was uploaded |\n * | viewers | Object\\[\\] | A set of objects including user or room Rainbow Id, type (user, room) |\n * | thumbnail | Object | Data of the thumbnail 'low resolution' (200X200 for images, 300x300 for .pdf, at least one dimension is 200 or 300)) |\n * | availableThumbnail | Boolean | Thumbnail availability |\n * | wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n * | size | Number | Thumbnail size |\n * | md5sum | String | md5 of the thumbnail get from the backend file storage |\n * | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n * | thumbnail500 | Object | Data of the thumbnail 'High resolution' (500x500 - at least one dimension is 500) |\n * | availableThumbnail | Boolean | Thumbnail availability |\n * | wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n * | size | Integer | Thumbnail size |\n * | md5sum | String | md5 of the thumbnail get from the backend file storage |\n * | isClean | Boolean | Null when the file is not yet scanned by an anti-virus |\n * | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n * | avReport | String | Null when the file is not yet scanned by an anti-virus |\n * | original_w | Number | For images only (jpeg, jpg, png, gif, pdf), this is the original width. It is processed at the same time as the thumbnails processing. (asynchronously) |\n * | original_h | Number | For images only (jpeg, jpg, png, gif, pdf), this is the original height. It is processed at the same time as the thumbnails processing. (asynchronously) |\n * | tags | Object | Wrap a set of data according with the file use |\n * | path | String | The path under which the owner will be able to classified the file. The folder management is not yet available; only a get files per path. For instance this facility is used to implement OXO visual voice mail feature on client side.
* /
* /voice-messages |\n * | msgId | String | When the file is generated by the Rainbow visual voice mail feature - The message Id (ex: \"g0F6jhGrIXN5NQa\") |\n * | messageType | String | When the file is generated by the Rainbow visual voice mail feature - The message type
default : `voice_message`
Possible values : `voice_message`, `conv_recording` |\n * | duration | Number | The message duration in second (voice message duration) |\n *\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 2158,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "fileOwnershipChange",
"scope": "instance",
"description": "As a file owner, I want to Drop the ownership to another Rainbow user of the same company.
\n Then:
\n
\nThe former owner becomes a viewer to stay allowed to get the display of the file.
\nThe new owner may loose his status of viewer when needed (as he becomes owner).
\n
\nError cases:\n\n- the former owner's company must allow file ownership change (forbidFileOwnerChangeCustomisation == disabled) errorDetailCode 403156 Access denied: this API can only be called by users having the feature key forbidFileOwnerChangeCustomisation disabled\n- the logged in user is not the owner (errorDetailsCode: 403629)\n- the new owner must belong to the same company of the current owner. errorDetailCode 403637 User [userId] doesn't belong to the company [companyId]\n- the target file is not uploaded yet. errorDetailCode 403638 File [fileId] is not uploaded yet. So it can't be re-allocated.\n- the new owner must have enough space to store the file.(errorDetailsCode: 403630)\n- A STANZA MESSAGE (type management) is sent to the owner and each viewers. (tag 'file', action='update', owner='xxxxxxxxxxxxx')",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "[required] Identifier of file descriptor to modify",
"name": "fileId"
},
{
"type": {
"names": [
"string"
]
},
"description": "ID of another user which will become owner.",
"name": "userId"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "File descriptor Object\n\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| data | Object | File descriptor Object |\n| id | String | File unique identifier (like 56d0277a0261b53142a5cab5) |\n| fileName | String | Name of the file |\n| ownerId | String | Rainbow Id of the file owner |\n| md5sum | String | md5 of the file get from the backend file storage (default: \"\", refreshed each time the file is uploaded) |\n| extension | String | File extension (jpeg, txt, ...) |\n| typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (image/jpeg,text/plain,...) |\n| size | Number | Size of the file (Default: value given by Rainbow clients). Refreshed from the backend file storage each time the file is uploaded. |\n| registrationDate | Date-Time | Date when the submit to upload this file was registered |\n| isUploaded | Boolean | true when the file was uploaded at least one time |\n| uploadedDate | Date-Time | Last time when the file was uploaded |\n| viewers | Object\\[\\] | A set of objects including user or room Rainbow Id, type (user, room) |\n| thumbnail | Object | Data of the thumbnail 'low resolution' (200X200 for images, 300x300 for .pdf, at least one dimension is 200 or 300)) |\n| availableThumbnail | Boolean | Thumbnail availability |\n| wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n| size | Number | Thumbnail size |\n| md5sum | String | md5 of the thumbnail get from the backend file storage |\n| typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n| thumbnail500 | Object | Data of the thumbnail 'High resolution' (500x500 - at least one dimension is 500) |\n| availableThumbnail | Boolean | Thumbnail availability |\n| wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n| size | Integer | Thumbnail size |\n| md5sum | String | md5 of the thumbnail get from the backend file storage |\n| isClean | Boolean | Null when the file is not yet scanned by an anti-virus |\n| typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n| avReport | String | Null when the file is not yet scanned by an anti-virus |\n| original_w | Number | For images only (jpeg, jpg, png, gif, pdf), this is the original width. It is processed at the same time as the thumbnails processing. (asynchronously) |\n| original_h | Number | For images only (jpeg, jpg, png, gif, pdf), this is the original height. It is processed at the same time as the thumbnails processing. (asynchronously) |\n| tags | Object | Wrap a set of data according with the file use |\n| path | String | The path under which the owner will be able to classified the file. The folder management is not yet available; only a get files per path. For instance this facility is used to implement OXO visual voice mail feature on client side.
* /
* /voice-messages |\n| msgId | String | When the file is generated by the Rainbow visual voice mail feature - The message Id (ex: \"g0F6jhGrIXN5NQa\") |\n| messageType | String | When the file is generated by the Rainbow visual voice mail feature - The message type
default : `voice_message`
Possible values : `voice_message`, `conv_recording` |\n| duration | Number | The message duration in second (voice message duration) |"
}
],
"longname": "module:FileStorage#fileOwnershipChange",
"memberof": "module:FileStorage",
"$longname": "FileStorage#fileOwnershipChange",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @since 1.47.1\n * @method getAllFilesReceived\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * Get the list of files (represented using an array of File Descriptor objects) received by the connected user from all of his conversations and bubbles.
\n * @return {FileDescriptor[]} Return an array containing a list of FileDescriptor objects representing the files received\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1820,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"since": "1.47.1",
"kind": "function",
"name": "getAllFilesReceived",
"scope": "instance",
"description": "Get the list of files (represented using an array of File Descriptor objects) received by the connected user from all of his conversations and bubbles.
",
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "Return an array containing a list of FileDescriptor objects representing the files received"
}
],
"longname": "module:FileStorage#getAllFilesReceived",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getAllFilesReceived",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @since 1.47.1\n * @method getAllFilesSent\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * Get the list of files (represented using an array of File Descriptor objects) created and owned by the connected which is the list of file sent to all of his conversations and bubbles.
\n * @return {FileDescriptor[]} Return an array containing the list of FileDescriptor objects representing the files sent\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1804,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"since": "1.47.1",
"kind": "function",
"name": "getAllFilesSent",
"scope": "instance",
"description": "Get the list of files (represented using an array of File Descriptor objects) created and owned by the connected which is the list of file sent to all of his conversations and bubbles.
",
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "Return an array containing the list of FileDescriptor objects representing the files sent"
}
],
"longname": "module:FileStorage#getAllFilesSent",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getAllFilesSent",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @since 1.47.1\n * @method getFileDescriptorFromId\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @param {String} id The file id\n * @description\n * Get the file descriptor the user own by it's id
\n * @return {FileDescriptor} Return a file descriptors found or null if no file descriptor has been found\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 823,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"since": "1.47.1",
"kind": "function",
"name": "getFileDescriptorFromId",
"scope": "instance",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "The file id",
"name": "id"
}
],
"description": "Get the file descriptor the user own by it's id
",
"returns": [
{
"type": {
"names": [
"FileDescriptor"
]
},
"description": "Return a file descriptors found or null if no file descriptor has been found"
}
],
"longname": "module:FileStorage#getFileDescriptorFromId",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getFileDescriptorFromId",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getFileDescriptorsByCompanyId\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * Get all file descriptors belonging to a given companyId.
\n * The result is paginated.
\n *\n * @param {string} companyId Company unique identifier. If no value is provided then the companyId of the connected user is used.\n * @param {boolean} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion.
\n *
\n * - typeMIME=audio/wav allows to get all wav file
\n * - typeMime=audio allows to get all audio files whatever the extension
\n * - typeMIME=audio/wav&typeMIME=audio/mp3 allows to get all wav and mp3 files
\n *
\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (rvcp_voice_promp, rvcp_record).
\n *
\n * - purpose=rvcp_voice_promp allows to get all voice prompt used by Rainbow Voice Communication Platform
\n * - purpose=rvcp_record allows to get all records generated by Rainbow Voice Communication Platform
\n * - purpose=rvcp allows to get all Rainbow Voice Communication Platform files
\n *
\n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} format Allows to retrieve viewers of each file when the format is full.
\n *
\n * - small: _id, fileName, extension, isClean
\n * - medium: _id, fileName, extension, typeMIME, size, isUploaded,isClean, avReport, thumbnail, thumbnail500, original_w, original_h
\n * - full: all descriptors fields except storageURL
\n *
\n * Default value : small
\n * Possible values : small, medium, full
\n *
\n * @param {number} limit Allow to specify the number of fileDescriptors to retrieve. Default value : 100\n * @param {number} offset Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.\n * @param {string} sortField Sort fileDescriptor list based on the given field. Default value : fileName\n * @param {number} sortOrder Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possible values : -1, 1\n * @return {Promise} all file descriptors belonging to a given companyId.\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 2058,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "getFileDescriptorsByCompanyId",
"scope": "instance",
"description": "Get all file descriptors belonging to a given companyId.
\nThe result is paginated.
",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "Company unique identifier. If no value is provided then the companyId of the connected user is used.",
"name": "companyId"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion.
\n
\n- typeMIME=audio/wav allows to get all wav file
\n- typeMime=audio allows to get all audio files whatever the extension
\n- typeMIME=audio/wav&typeMIME=audio/mp3 allows to get all wav and mp3 files
\n
",
"name": "typeMIME"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (rvcp_voice_promp, rvcp_record).
\n
\n- purpose=rvcp_voice_promp allows to get all voice prompt used by Rainbow Voice Communication Platform
\n- purpose=rvcp_record allows to get all records generated by Rainbow Voice Communication Platform
\n- purpose=rvcp allows to get all Rainbow Voice Communication Platform files
\n
",
"name": "purpose"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to retrieve viewers of each file when the format is full.
\n
\n- small: _id, fileName, extension, isClean
\n- medium: _id, fileName, extension, typeMIME, size, isUploaded,isClean, avReport, thumbnail, thumbnail500, original_w, original_h
\n- full: all descriptors fields except storageURL
\n
\nDefault value : small
\nPossible values : small, medium, full
\n
",
"name": "format"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the number of fileDescriptors to retrieve. Default value : 100",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort fileDescriptor list based on the given field. Default value : fileName",
"name": "sortField"
},
{
"type": {
"names": [
"number"
]
},
"description": "Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possible values : -1, 1",
"name": "sortOrder"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "all file descriptors belonging to a given companyId."
}
],
"longname": "module:FileStorage#getFileDescriptorsByCompanyId",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getFileDescriptorsByCompanyId",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @since 1.47.1\n * @method getFilesReceivedInConversation\n * @instance\n * @async\n * @param {Conversation} conversation The conversation where to get the files\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * Get the list of all files received in a conversation with a contact
\n * Return a promise
\n * @return {FileDescriptor[]} Return an array of file descriptors found or an empty array if no file descriptor has been found\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 840,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"since": "1.47.1",
"kind": "function",
"name": "getFilesReceivedInConversation",
"scope": "instance",
"async": true,
"params": [
{
"type": {
"names": [
"Conversation"
]
},
"description": "The conversation where to get the files",
"name": "conversation"
}
],
"description": "Get the list of all files received in a conversation with a contact
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "Return an array of file descriptors found or an empty array if no file descriptor has been found"
}
],
"longname": "module:FileStorage#getFilesReceivedInConversation",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getFilesReceivedInConversation",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @since 1.47.1\n * @method getFilesSentInBubble\n * @instance\n * @param {Bubble} bubble The bubble where to get the files\n * @param {boolean} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion. \n * typeMIME='image/jpeg' allows to get all jpeg file \n * typeMime='image' allows to get all image files whatever the extension \n * typeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files \n * typeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension \n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference\n * @param {string} path For visual voice mail feature only (step1), allows to get file descriptors of each file under the given path.\n * @param {string} format Allows to retrieve viewers of each file when the format is full.\n * small: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * medium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * full: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\n * Default value : full. Possibles values : small, medium, full\n * @param {number} limit Allow to specify the number of fileDescriptors to retrieve. Default value : 100\n * @param {number} offset Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.\n * @param {string} sortField Sort fileDescriptor list based on the given field. Default value : fileName\n * @param {number} sortOrder Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possibles values : -1, 1\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * Get the list of all files sent in a bubble
\n * Return a promise
\n * @return {FileDescriptor[]} Return an array of file descriptors found or an empty array if no file descriptor has been found\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1727,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"since": "1.47.1",
"kind": "function",
"name": "getFilesSentInBubble",
"scope": "instance",
"params": [
{
"type": {
"names": [
"Bubble"
]
},
"description": "The bubble where to get the files",
"name": "bubble"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion. \ntypeMIME='image/jpeg' allows to get all jpeg file \ntypeMime='image' allows to get all image files whatever the extension \ntypeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files \ntypeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension ",
"name": "typeMIME"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference",
"name": "purpose"
},
{
"type": {
"names": [
"string"
]
},
"description": "For visual voice mail feature only (step1), allows to get file descriptors of each file under the given path.",
"name": "path"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to retrieve viewers of each file when the format is full.\nsmall: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nmedium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nfull: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\nDefault value : full. Possibles values : small, medium, full",
"name": "format"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the number of fileDescriptors to retrieve. Default value : 100",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort fileDescriptor list based on the given field. Default value : fileName",
"name": "sortField"
},
{
"type": {
"names": [
"number"
]
},
"description": "Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possibles values : -1, 1",
"name": "sortOrder"
}
],
"description": "Get the list of all files sent in a bubble
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "Return an array of file descriptors found or an empty array if no file descriptor has been found"
}
],
"longname": "module:FileStorage#getFilesSentInBubble",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getFilesSentInBubble",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.47.1\n * @nodered true\n * @method getFilesSentInConversation\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @param {Conversation} conversation The conversation where to get the files\n * @param {boolean} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion. \n * typeMIME='image/jpeg' allows to get all jpeg file \n * typeMime='image' allows to get all image files whatever the extension \n * typeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files \n * typeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension \n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference\n * @param {string} format Allows to retrieve viewers of each file when the format is full.\n * small: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * medium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * full: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\n * Default value : full. Possibles values : small, medium, full\n * @param {number} limit Allow to specify the number of fileDescriptors to retrieve. Default value : 100\n * @param {number} offset Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.\n * @param {string} sortField Sort fileDescriptor list based on the given field. Default value : fileName\n * @param {number} sortOrder Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possibles values : -1, 1\n * @description\n * Get the list of all files sent in a conversation with a contact
\n * Return a promise
\n * @return {FileDescriptor[]} Return an array of file descriptors found or an empty array if no file descriptor has been found\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1662,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.47.1",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "getFilesSentInConversation",
"scope": "instance",
"params": [
{
"type": {
"names": [
"Conversation"
]
},
"description": "The conversation where to get the files",
"name": "conversation"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion. \ntypeMIME='image/jpeg' allows to get all jpeg file \ntypeMime='image' allows to get all image files whatever the extension \ntypeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files \ntypeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension ",
"name": "typeMIME"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference",
"name": "purpose"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to retrieve viewers of each file when the format is full.\nsmall: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nmedium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nfull: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\nDefault value : full. Possibles values : small, medium, full",
"name": "format"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the number of fileDescriptors to retrieve. Default value : 100",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort fileDescriptor list based on the given field. Default value : fileName",
"name": "sortField"
},
{
"type": {
"names": [
"number"
]
},
"description": "Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possibles values : -1, 1",
"name": "sortOrder"
}
],
"description": "Get the list of all files sent in a conversation with a contact
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "Return an array of file descriptors found or an empty array if no file descriptor has been found"
}
],
"longname": "module:FileStorage#getFilesSentInConversation",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getFilesSentInConversation",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.47.1\n * @nodered true\n * @method getFilesTemporaryURL\n * @instance\n * @async\n * @category Files TRANSFER\n * @param {string} fileId The id of description of the file to get download url.\n * @description\n * In order to use a download manager, get a file backend temporary URL.
\n * Return a promise
\n * @return {Object} Return a SDK OK Object or a SDK error object depending the result\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 643,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.47.1",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "getFilesTemporaryURL",
"scope": "instance",
"async": true,
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The id of description of the file to get download url.",
"name": "fileId"
}
],
"description": "In order to use a download manager, get a file backend temporary URL.
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Object"
]
},
"description": "Return a SDK OK Object or a SDK error object depending the result"
}
],
"longname": "module:FileStorage#getFilesTemporaryURL",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getFilesTemporaryURL",
"$kind": "method"
},
{
"comment": "/**\n * @nodered true\n * @method getReceivedFilesForRoom\n * @public\n *\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @param {string} bubbleId id of the bubble\n * @description\n * Method to get the list of received files descriptors.\n * @return {FileDescriptor[]}\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1124,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "getReceivedFilesForRoom",
"access": "public",
"scope": "instance",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "id of the bubble",
"name": "bubbleId"
}
],
"description": "Method to get the list of received files descriptors.",
"returns": [
{
"type": {
"names": [
"Array."
]
}
}
],
"longname": "module:FileStorage#getReceivedFilesForRoom",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getReceivedFilesForRoom",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @since 1.47.1\n * @method getUserQuotaConsumption\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @instance\n * @description\n * Get the current file storage quota and consumption for the connected user
\n * Return a promise
\n * @return {Object} Return an object containing the user quota and consumption\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1783,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"since": "1.47.1",
"kind": "function",
"name": "getUserQuotaConsumption",
"scope": "instance",
"description": "Get the current file storage quota and consumption for the connected user
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Object"
]
},
"description": "Return an object containing the user quota and consumption"
}
],
"longname": "module:FileStorage#getUserQuotaConsumption",
"memberof": "module:FileStorage",
"$longname": "FileStorage#getUserQuotaConsumption",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.47.1\n * @nodered true\n * @method removeFile\n * @instance\n * @async\n * @category Files TRANSFER\n * @param {FileDescriptor} fileDescriptor The description of the file to remove (short file descriptor)\n * @description\n * Remove an uploaded file
\n * Return a promise
\n * @return {Object} Return a SDK OK Object or a SDK error object depending the result\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 678,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.47.1",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "removeFile",
"scope": "instance",
"async": true,
"params": [
{
"type": {
"names": [
"FileDescriptor"
]
},
"description": "The description of the file to remove (short file descriptor)",
"name": "fileDescriptor"
}
],
"description": "Remove an uploaded file
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Object"
]
},
"description": "Return a SDK OK Object or a SDK error object depending the result"
}
],
"longname": "module:FileStorage#removeFile",
"memberof": "module:FileStorage",
"$longname": "FileStorage#removeFile",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method retrieveFileDescriptorsListPerOwner\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @async\n * @instance\n * @param {string} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion.\n * typeMIME='image/jpeg' allows to get all jpeg file\n * typeMime='image' allows to get all image files whatever the extension\n * typeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files\n * typeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference\n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} viewerId Among all files shared by the user, allow to specify a viewer.\n * @param {string} path For visual voice mail feature only (step1), allows to get file descriptors of each file under the given path.\n * @param {number} limit=1000 Allow to specify the number of items to retrieve. Default value : 1000 Possibles values : 0-1000\n * @param {number} offset=0 Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned. Default value : 0\n * @param {string} sortField Sort items list based on the given field.\n * @param {string} sortOrder=1 Specify order when sorting items list. Default value : 1 Possibles values : -1, 1\n * @param {string} format=\"full\" Allows to retrieve more or less file descriptors details in response.\n * small: _id, fileName, extension, isClean\n * medium: _id, fileName, extension, typeMIME, size, isUploaded,isClean, avReport, thumbnail, thumbnail500, original_w, original_h\n * full: all descriptors fields except storageURL\n * Default value : full Possibles values : \"small\", \"medium\", \"full\"\n * @description\n * Method retrieve full list of files belonging to user making the request
\n *\n * @return {Promise}\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1289,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "retrieveFileDescriptorsListPerOwner",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion.\ntypeMIME='image/jpeg' allows to get all jpeg file\ntypeMime='image' allows to get all image files whatever the extension\ntypeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files\ntypeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension",
"name": "typeMIME"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference",
"name": "purpose"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "Among all files shared by the user, allow to specify a viewer.",
"name": "viewerId"
},
{
"type": {
"names": [
"string"
]
},
"description": "For visual voice mail feature only (step1), allows to get file descriptors of each file under the given path.",
"name": "path"
},
{
"type": {
"names": [
"number"
]
},
"defaultvalue": 1000,
"description": "Allow to specify the number of items to retrieve. Default value : 1000 Possibles values : 0-1000",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"defaultvalue": 0,
"description": "Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned. Default value : 0",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort items list based on the given field.",
"name": "sortField"
},
{
"type": {
"names": [
"string"
]
},
"defaultvalue": 1,
"description": "Specify order when sorting items list. Default value : 1 Possibles values : -1, 1",
"name": "sortOrder"
},
{
"type": {
"names": [
"string"
]
},
"defaultvalue": "\"full\"",
"description": "Allows to retrieve more or less file descriptors details in response.\nsmall: _id, fileName, extension, isClean\nmedium: _id, fileName, extension, typeMIME, size, isUploaded,isClean, avReport, thumbnail, thumbnail500, original_w, original_h\nfull: all descriptors fields except storageURL\nDefault value : full Possibles values : \"small\", \"medium\", \"full\"",
"name": "format"
}
],
"description": "Method retrieve full list of files belonging to user making the request
",
"returns": [
{
"type": {
"names": [
"Promise.>"
]
}
}
],
"longname": "module:FileStorage#retrieveFileDescriptorsListPerOwner",
"memberof": "module:FileStorage",
"$longname": "FileStorage#retrieveFileDescriptorsListPerOwner",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method retrieveOneFileDescriptor\n * @instance\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @description\n * Method retrieve a specific file descriptor from server
\n *\n * @param {string} fileId [required] Identifier of file descriptor to retrieve\n * @return {Promise} file descriptor retrieved\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1963,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "retrieveOneFileDescriptor",
"scope": "instance",
"description": "Method retrieve a specific file descriptor from server
",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "[required] Identifier of file descriptor to retrieve",
"name": "fileId"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "file descriptor retrieved"
}
],
"longname": "module:FileStorage#retrieveOneFileDescriptor",
"memberof": "module:FileStorage",
"$longname": "FileStorage#retrieveOneFileDescriptor",
"$kind": "method"
},
{
"comment": "/**\n *\n * @public\n * @nodered true\n * @method retrieveReceivedFiles\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @instance\n * @async\n * @description\n * Method request for the list of files received by a user
\n *\n * @param {string} viewerId [required] Id of the viewer, could be either an userId or a bubbleId\n * @param {string} ownerId Among all files shared with the user, allow to precify a provider. Example a peerId in a face to face conversation.\n * @param {boolean} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion. \n * typeMIME='image/jpeg' allows to get all jpeg file \n * typeMime='image' allows to get all image files whatever the extension \n * typeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files \n * typeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension \n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference\n * @param {string} roomName A word of the conference name. When purpose=conference_record is used, allow to reduce the list of results focusing of the recording name.\n * @param {boolean} overall When true, allow to get all files (my files and received files) in the same paginated list\n * @param {string} format Allows to retrieve viewers of each file when the format is full.\n * small: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * medium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * full: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\n * Default value : full. Possibles values : small, medium, full\n * @param {number} limit Allow to specify the number of fileDescriptors to retrieve. Default value : 100\n * @param {number} offset Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.\n * @param {string} sortField Sort fileDescriptor list based on the given field. Default value : fileName\n * @param {number} sortOrder Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possibles values : -1, 1\n * @return {Promise} : list of received files descriptors\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1591,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "retrieveReceivedFiles",
"scope": "instance",
"async": true,
"description": "Method request for the list of files received by a user
",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "[required] Id of the viewer, could be either an userId or a bubbleId",
"name": "viewerId"
},
{
"type": {
"names": [
"string"
]
},
"description": "Among all files shared with the user, allow to precify a provider. Example a peerId in a face to face conversation.",
"name": "ownerId"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion. \ntypeMIME='image/jpeg' allows to get all jpeg file \ntypeMime='image' allows to get all image files whatever the extension \ntypeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files \ntypeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension ",
"name": "typeMIME"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference",
"name": "purpose"
},
{
"type": {
"names": [
"string"
]
},
"description": "A word of the conference name. When purpose=conference_record is used, allow to reduce the list of results focusing of the recording name.",
"name": "roomName"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "When true, allow to get all files (my files and received files) in the same paginated list",
"name": "overall"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to retrieve viewers of each file when the format is full.\nsmall: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nmedium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nfull: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\nDefault value : full. Possibles values : small, medium, full",
"name": "format"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the number of fileDescriptors to retrieve. Default value : 100",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort fileDescriptor list based on the given field. Default value : fileName",
"name": "sortField"
},
{
"type": {
"names": [
"number"
]
},
"description": "Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1. Possibles values : -1, 1",
"name": "sortOrder"
}
],
"returns": [
{
"type": {
"names": [
"Promise.>"
]
},
"description": ": list of received files descriptors"
}
],
"longname": "module:FileStorage#retrieveReceivedFiles",
"memberof": "module:FileStorage",
"$longname": "FileStorage#retrieveReceivedFiles",
"$kind": "method"
},
{
"comment": "/**\n * @public\n *\n * @nodered true\n * @method retrieveReceivedFilesForRoom\n * @instance\n * @description\n * Method request for the list of files received in a room
\n *\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @param {string} bubbleId [required] Id of the room\n * @param {string} ownerId Among all files shared with the user, allow to precify a provider.\n * @param {boolean} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion.\n * typeMIME='image/jpeg' allows to get all jpeg file\n * typeMime='image' allows to get all image files whatever the extension\n * typeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files\n * typeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension\n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference\n * @param {string} roomName A word of the conference name. When purpose=conference_record is used, allow to reduce the list of results focusing of the recording name.\n * @param {boolean} overall When true, allow to get all files (my files and received files) in the same paginated list\n * @param {string} format Allows to retrieve viewers of each file when the format is full.\n * small: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * medium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\n * full: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\n * Default value : full Possibles values : small, medium, full\n * @param {number} limit Allow to specify the number of fileDescriptors to retrieve. Default value : 1000\n * @param {number} offset Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.\n * @param {string} sortField Sort fileDescriptor list based on the given field. Default value : fileName\n * @param {number} sortOrder Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1 Possibles values : -1, 1\n * @return {Promise} : list of received files descriptors\n *\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | data | Object | File descriptor Object |\n * | tags | Object | Wrap a set of data according with the file use |\n * | path | String | The path under which the owner will be able to classified the file. The folder management is not yet available; only a get files per path. For instance this facility is used to implement OXO visual voice mail feature on client side.
* /
* /voice-messages |\n * | msgId | String | When the file is generated by the Rainbow visual voice mail feature - The message Id (ex: \"g0F6jhGrIXN5NQa\") |\n * | messageType | String | When the file is generated by the Rainbow visual voice mail feature - The message type
Valeur par défaut : `voice_message`
Valeurs autorisées : `voice_message`, `conv_recording` |\n * | duration | Number | The message duration in second (voice message duration) |\n * | id | String | File unique identifier (like 56d0277a0261b53142a5cab5) |\n * | fileName | String | Name of the file |\n * | extension | String | File extension (jpeg, txt, ...) |\n * | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (image/jpeg, text/plain, ...) |\n * | ownerId | String | Rainbow Id of the file owner. Useful to filter file descriptor for files shared inside a room. In this case the provider is also a viewer. |\n * | isUploaded | Boolean | true when the file was uploaded at least one time |\n * | size | Number | Size of the file (Default: value given by Rainbow clients). Refreshed from the backend file storage each time the file is uploaded. |\n * | viewers | Object\\[\\] | A set of objects including user or room Rainbow Id, type (user, room) |\n * | dateToSort | Date-Time | A processed date to help ordering descriptors not only from the file name.
dateToSort is processed as follow:
* `Default value`: either file is never uploaded : dateToSort = 1970-01-01T00:00:00.000Z or file is uploaded but no downloaded date is available : dateToSort = upLoadedDate
* In case of the viewerId is a user, a downloadedDate may override the default value. In this case dateToSort is the `downloadedDate`.
* When a query sorted by uploadedDate is wanted (`sort=uploadedDate`), no 'dateToSort' processing is done. The uploadedDate field is copied instead. |\n * | thumbnail | Object | Data of the thumbnail 'low resolution' (200X200 for images, 300x300 for .pdf, at least one dimension is 200 or 300)) |\n * | availableThumbnail | Boolean | Thumbnail availability |\n * | wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n * | size | Number | Thumbnail size |\n * | md5sum | String | md5 of the thumbnail get from the backend file storage |\n * | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n * | thumbnail500 | Object | Data of the thumbnail 'High resolution' (500x500 - at least one dimension is 500) |\n * | availableThumbnail | Boolean | Thumbnail availability |\n * | wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n * | size | Number | Thumbnail size |\n * | md5sum | String | md5 of the thumbnail get from the backend file storage |\n * | isClean | Boolean | Null when the file is not yet scanned by an anti-virus |\n * | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n * | avReport | String | Null when the file is not yet scanned by an anti-virus |\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1493,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "retrieveReceivedFilesForRoom",
"scope": "instance",
"description": "Method request for the list of files received in a room
",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "[required] Id of the room",
"name": "bubbleId"
},
{
"type": {
"names": [
"string"
]
},
"description": "Among all files shared with the user, allow to precify a provider.",
"name": "ownerId"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion.\ntypeMIME='image/jpeg' allows to get all jpeg file\ntypeMime='image' allows to get all image files whatever the extension\ntypeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files\ntypeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension",
"name": "typeMIME"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference",
"name": "purpose"
},
{
"type": {
"names": [
"string"
]
},
"description": "A word of the conference name. When purpose=conference_record is used, allow to reduce the list of results focusing of the recording name.",
"name": "roomName"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "When true, allow to get all files (my files and received files) in the same paginated list",
"name": "overall"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to retrieve viewers of each file when the format is full.\nsmall: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nmedium: _id fileName extension typeMIME ownerId isUploaded uploadedDate size thumbnail thumbnail500 isClean tags\nfull: _id fileName extension typeMIME ownerId isUploaded uploadedDate size viewers thumbnail thumbnail500 isClean tags\nDefault value : full Possibles values : small, medium, full",
"name": "format"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the number of fileDescriptors to retrieve. Default value : 1000",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the position of first fileDescriptor to retrieve (first fileDescriptor if not specified). Warning: if offset > total, no results are returned.",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort fileDescriptor list based on the given field. Default value : fileName",
"name": "sortField"
},
{
"type": {
"names": [
"number"
]
},
"description": "Specify order when sorting fileDescriptor list (1: arranged in alphabetical order, -1: reverse order). Default value : 1 Possibles values : -1, 1",
"name": "sortOrder"
}
],
"returns": [
{
"type": {
"names": [
"Promise.>"
]
},
"description": ": list of received files descriptors\n\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | data | Object | File descriptor Object |\n | tags | Object | Wrap a set of data according with the file use |\n | path | String | The path under which the owner will be able to classified the file. The folder management is not yet available; only a get files per path. For instance this facility is used to implement OXO visual voice mail feature on client side.
* /
* /voice-messages |\n | msgId | String | When the file is generated by the Rainbow visual voice mail feature - The message Id (ex: \"g0F6jhGrIXN5NQa\") |\n | messageType | String | When the file is generated by the Rainbow visual voice mail feature - The message type
Valeur par défaut : `voice_message`
Valeurs autorisées : `voice_message`, `conv_recording` |\n | duration | Number | The message duration in second (voice message duration) |\n | id | String | File unique identifier (like 56d0277a0261b53142a5cab5) |\n | fileName | String | Name of the file |\n | extension | String | File extension (jpeg, txt, ...) |\n | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (image/jpeg, text/plain, ...) |\n | ownerId | String | Rainbow Id of the file owner. Useful to filter file descriptor for files shared inside a room. In this case the provider is also a viewer. |\n | isUploaded | Boolean | true when the file was uploaded at least one time |\n | size | Number | Size of the file (Default: value given by Rainbow clients). Refreshed from the backend file storage each time the file is uploaded. |\n | viewers | Object\\[\\] | A set of objects including user or room Rainbow Id, type (user, room) |\n | dateToSort | Date-Time | A processed date to help ordering descriptors not only from the file name.
dateToSort is processed as follow:
* `Default value`: either file is never uploaded : dateToSort = 1970-01-01T00:00:00.000Z or file is uploaded but no downloaded date is available : dateToSort = upLoadedDate
* In case of the viewerId is a user, a downloadedDate may override the default value. In this case dateToSort is the `downloadedDate`.
* When a query sorted by uploadedDate is wanted (`sort=uploadedDate`), no 'dateToSort' processing is done. The uploadedDate field is copied instead. |\n | thumbnail | Object | Data of the thumbnail 'low resolution' (200X200 for images, 300x300 for .pdf, at least one dimension is 200 or 300)) |\n | availableThumbnail | Boolean | Thumbnail availability |\n | wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n | size | Number | Thumbnail size |\n | md5sum | String | md5 of the thumbnail get from the backend file storage |\n | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n | thumbnail500 | Object | Data of the thumbnail 'High resolution' (500x500 - at least one dimension is 500) |\n | availableThumbnail | Boolean | Thumbnail availability |\n | wantThumbnailDate | Date-Time | When the thumbnail is ordered |\n | size | Number | Thumbnail size |\n | md5sum | String | md5 of the thumbnail get from the backend file storage |\n | isClean | Boolean | Null when the file is not yet scanned by an anti-virus |\n | typeMIME | String | https://fr.wikipedia.org/wiki/Type_MIME (application/octet-stream) |\n | avReport | String | Null when the file is not yet scanned by an anti-virus |"
}
],
"longname": "module:FileStorage#retrieveReceivedFilesForRoom",
"memberof": "module:FileStorage",
"$longname": "FileStorage#retrieveReceivedFilesForRoom",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method retrieveSentFiles\n * @category Files FILE MANAGEMENT / PROPERTIES\n * @instance\n * @description\n * Method request for the list of files sent to a given peer (i.e. inside a given conversation)
\n *\n * @param {string} peerId [required] id of peer user in the conversation\n * @param {string} fileName Allows to filter file descriptors by fileName criterion.\n * @param {string} extension Allows to filter file descriptors by extension criterion.\n * @param {string} typeMIME Allows to filter file descriptors by typeMIME criterion.\n * typeMIME='image/jpeg' allows to get all jpeg file\n * typeMime='image' allows to get all image files whatever the extension\n * typeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files\n * typeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension\n * @param {string} purpose Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference\n * @param {boolean} isUploaded Allows to filter file descriptors by isUploaded criterion.\n * @param {string} path For visual voice mail feature only (step1), allows to get file descriptors of each file under the given path.\n * @param {number} limit Allow to specify the number of items to retrieve. Default value : 1000 Possibles values : 0-1000\n * @param {number} offset Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned. Default value : 0\n * @param {string} sortField Sort items list based on the given field.\n * @param {string} sortOrder Specify order when sorting items list. Default value : 1 Possibles values : -1, 1\n * @param {string} format Allows to retrieve more or less file descriptors details in response.\n * small: _id, fileName, extension, isClean\n * medium: _id, fileName, extension, typeMIME, size, isUploaded,isClean, avReport, thumbnail, thumbnail500, original_w, original_h\n * full: all descriptors fields except storageURL\n * Default value : full Possibles values : \"small\", \"medium\", \"full\"\n * @return {Promise} : list of sent files descriptors\n *\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 1435,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files FILE MANAGEMENT / PROPERTIES",
"value": "Files FILE MANAGEMENT / PROPERTIES"
}
],
"kind": "function",
"name": "retrieveSentFiles",
"scope": "instance",
"description": "Method request for the list of files sent to a given peer (i.e. inside a given conversation)
",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "[required] id of peer user in the conversation",
"name": "peerId"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by fileName criterion.",
"name": "fileName"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by extension criterion.",
"name": "extension"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by typeMIME criterion.\ntypeMIME='image/jpeg' allows to get all jpeg file\ntypeMime='image' allows to get all image files whatever the extension\ntypeMIME='image/jpeg'&typeMIME='image/png' allows to get all jpeg and png files\ntypeMIME='image'&typeMIME='video' allows to get all image and video files whatever the extension",
"name": "typeMIME"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to filter file descriptors by the utility of the file (conference_record for instance). purpose=conference_record allows to get all records of conference",
"name": "purpose"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "Allows to filter file descriptors by isUploaded criterion.",
"name": "isUploaded"
},
{
"type": {
"names": [
"string"
]
},
"description": "For visual voice mail feature only (step1), allows to get file descriptors of each file under the given path.",
"name": "path"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the number of items to retrieve. Default value : 1000 Possibles values : 0-1000",
"name": "limit"
},
{
"type": {
"names": [
"number"
]
},
"description": "Allow to specify the position of first item to retrieve (first item if not specified). Warning: if offset > total, no results are returned. Default value : 0",
"name": "offset"
},
{
"type": {
"names": [
"string"
]
},
"description": "Sort items list based on the given field.",
"name": "sortField"
},
{
"type": {
"names": [
"string"
]
},
"description": "Specify order when sorting items list. Default value : 1 Possibles values : -1, 1",
"name": "sortOrder"
},
{
"type": {
"names": [
"string"
]
},
"description": "Allows to retrieve more or less file descriptors details in response.\nsmall: _id, fileName, extension, isClean\nmedium: _id, fileName, extension, typeMIME, size, isUploaded,isClean, avReport, thumbnail, thumbnail500, original_w, original_h\nfull: all descriptors fields except storageURL\nDefault value : full Possibles values : \"small\", \"medium\", \"full\"",
"name": "format"
}
],
"returns": [
{
"type": {
"names": [
"Promise.>"
]
},
"description": ": list of sent files descriptors"
}
],
"longname": "module:FileStorage#retrieveSentFiles",
"memberof": "module:FileStorage",
"$longname": "FileStorage#retrieveSentFiles",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.47.1\n * @nodered true\n * @method uploadFileToBubble\n * @instance\n * @async\n * @category Files TRANSFER\n * @param {Bubble} bubble The bubble where the message will be added\n * @param {File} file The file to add\n * @param {String} strMessage An optional message to add with the file\n * @param {DataStoreType} p_messagesDataStore used to override the general of SDK's parameter \"messagesDataStore\". default value `undefined` to use the general value.\n * DataStoreType.NoStore Tell the server to NOT store the messages for delay distribution or for history of the bot and the contact.\n * DataStoreType.NoPermanentStore Tell the server to NOT store the messages for history of the bot and the contact. But being stored temporarily as a normal part of delivery (e.g. if the recipient is offline at the time of sending).\n * DataStoreType.StoreTwinSide The messages are fully stored.\n * DataStoreType.UsestoreMessagesField to follow the storeMessages SDK's parameter behaviour.\n * @description\n * Allow to add a file to an existing Bubble conversation
\n * Return a promise
\n * @return {Message} Return the message sent
\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 280,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.47.1",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "uploadFileToBubble",
"scope": "instance",
"async": true,
"params": [
{
"type": {
"names": [
"Bubble"
]
},
"description": "The bubble where the message will be added",
"name": "bubble"
},
{
"type": {
"names": [
"File"
]
},
"description": "The file to add",
"name": "file"
},
{
"type": {
"names": [
"String"
]
},
"description": "An optional message to add with the file",
"name": "strMessage"
},
{
"type": {
"names": [
"DataStoreType"
]
},
"description": "used to override the general of SDK's parameter \"messagesDataStore\". default value `undefined` to use the general value.\nDataStoreType.NoStore Tell the server to NOT store the messages for delay distribution or for history of the bot and the contact.\nDataStoreType.NoPermanentStore Tell the server to NOT store the messages for history of the bot and the contact. But being stored temporarily as a normal part of delivery (e.g. if the recipient is offline at the time of sending).\nDataStoreType.StoreTwinSide The messages are fully stored.\nDataStoreType.UsestoreMessagesField to follow the storeMessages SDK's parameter behaviour.",
"name": "p_messagesDataStore"
}
],
"description": "Allow to add a file to an existing Bubble conversation
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Message"
]
},
"description": "Return the message sent
"
}
],
"longname": "module:FileStorage#uploadFileToBubble",
"memberof": "module:FileStorage",
"$longname": "FileStorage#uploadFileToBubble",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.47.1\n * @nodered true\n * @method uploadFileToConversation\n * @instance\n * @async\n * @category Files TRANSFER\n * @param {Conversation} conversation The conversation where the message will be added\n * @param {{size, type, name, preview, path}} object reprensenting The file to add. Properties are : the Size of the file in octets, the mimetype, the name, a thumbnail preview if it is an image, the path to the file to share.\n * @param {String} strMessage An optional message to add with the file\n * @param {DataStoreType} p_messagesDataStore used to override the general of SDK's parameter \"messagesDataStore\". default value `undefined` to use the general value.\n * DataStoreType.NoStore Tell the server to NOT store the messages for delay distribution or for history of the bot and the contact.\n * DataStoreType.NoPermanentStore Tell the server to NOT store the messages for history of the bot and the contact. But being stored temporarily as a normal part of delivery (e.g. if the recipient is offline at the time of sending).\n * DataStoreType.StoreTwinSide The messages are fully stored.\n * DataStoreType.UsestoreMessagesField to follow the storeMessages SDK's parameter behaviour.\n * @description\n * Allow to add a file to an existing conversation (ie: conversation with a contact)
\n * Return the promise
\n * @return {Message} Return the message sent
\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 214,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.47.1",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "uploadFileToConversation",
"scope": "instance",
"async": true,
"params": [
{
"type": {
"names": [
"Conversation"
]
},
"description": "The conversation where the message will be added",
"name": "conversation"
},
{
"type": {
"names": [
"Object"
]
},
"description": "reprensenting The file to add. Properties are : the Size of the file in octets, the mimetype, the name, a thumbnail preview if it is an image, the path to the file to share.",
"name": "object"
},
{
"type": {
"names": [
"String"
]
},
"description": "An optional message to add with the file",
"name": "strMessage"
},
{
"type": {
"names": [
"DataStoreType"
]
},
"description": "used to override the general of SDK's parameter \"messagesDataStore\". default value `undefined` to use the general value.\nDataStoreType.NoStore Tell the server to NOT store the messages for delay distribution or for history of the bot and the contact.\nDataStoreType.NoPermanentStore Tell the server to NOT store the messages for history of the bot and the contact. But being stored temporarily as a normal part of delivery (e.g. if the recipient is offline at the time of sending).\nDataStoreType.StoreTwinSide The messages are fully stored.\nDataStoreType.UsestoreMessagesField to follow the storeMessages SDK's parameter behaviour.",
"name": "p_messagesDataStore"
}
],
"description": "Allow to add a file to an existing conversation (ie: conversation with a contact)
\n Return the promise
",
"returns": [
{
"type": {
"names": [
"Message"
]
},
"description": "Return the message sent
"
}
],
"longname": "module:FileStorage#uploadFileToConversation",
"memberof": "module:FileStorage",
"$longname": "FileStorage#uploadFileToConversation",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @since 1.67.0\n * @nodered true\n * @method uploadFileToStorage\n * @category Files TRANSFER\n * @async\n * @param {String|File} file An {size, type, name, preview, path}} object reprensenting The file to add. Properties are : the Size of the file in octets, the mimetype, the name, a thumbnail preview if it is an image, the path to the file to share.\n * @param {boolean} voicemessage When set to True, that allows to identify voice memos in a chat or multi-users chat conversation.\n * @param {number} duration The voice message in seconds. This field must be a positive number and is only taken into account when voicemessage is true.\n * @param {boolean} encoding AAC is the choosen format to encode a voice message. This is the native format for mobile clients, nor web client (OPUS, OGG..). This field must be set to true to order a transcodind and is only taken into account when voicemessage is true.\n * @param {boolean} ccarelogs When set to True, that allows to identify a log file uploaded by the user\n * @param {boolean} ccareclientlogs When set to True, that allows to identify a log file uploaded automatically by the client application\n * @instance\n * @description\n * Send a file in user storage
\n */",
"meta": {
"filename": "FileStorageService.js",
"lineno": 363,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"since": "1.67.0",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Files TRANSFER",
"value": "Files TRANSFER"
}
],
"kind": "function",
"name": "uploadFileToStorage",
"async": true,
"params": [
{
"type": {
"names": [
"String",
"File"
]
},
"description": "An {size, type, name, preview, path}} object reprensenting The file to add. Properties are : the Size of the file in octets, the mimetype, the name, a thumbnail preview if it is an image, the path to the file to share.",
"name": "file"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "When set to True, that allows to identify voice memos in a chat or multi-users chat conversation.",
"name": "voicemessage"
},
{
"type": {
"names": [
"number"
]
},
"description": "The voice message in seconds. This field must be a positive number and is only taken into account when voicemessage is true.",
"name": "duration"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "AAC is the choosen format to encode a voice message. This is the native format for mobile clients, nor web client (OPUS, OGG..). This field must be set to true to order a transcodind and is only taken into account when voicemessage is true.",
"name": "encoding"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "When set to True, that allows to identify a log file uploaded by the user",
"name": "ccarelogs"
},
{
"type": {
"names": [
"boolean"
]
},
"description": "When set to True, that allows to identify a log file uploaded automatically by the client application",
"name": "ccareclientlogs"
}
],
"scope": "instance",
"description": "Send a file in user storage
",
"longname": "module:FileStorage#uploadFileToStorage",
"memberof": "module:FileStorage",
"$longname": "FileStorage#uploadFileToStorage",
"$kind": "method"
}
]