Get all files in a DM.
Changelog
| Version | Description |
|---|---|
| 9.0.0 | Removed the fields and query parameters. |
| 0.64.0 | Change userId to user object in response |
| 0.59.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }. Refer to the official documentation to learn more.
Filter results by the type of file. Available options:
all: Return all file types.image: Filter by image files.video: Filter by video files.audio: Filter by audio files.text: Filter by text documents.application: Filter by other file types.
The name of the file to search for.
The roomId of the DM. It is required if username is not provided.
The username of the user in the DM. It is required if roomId is not provided.
OK
{
"files": [
{
"_id": "6542e355a2f73c7460e18ef6",
"name": "2023-11-01_21-13-38.snagx",
"size": 652277,
"type": "application/octet-stream",
"rid": "5fRTXMt7DMJbpPJfhgzvcvpov9G4TxbGFS",
"userId": "5fRTXMt7DMJbpPJfh",
"store": "GridFS:Uploads",
"_updatedAt": "2023-11-01T23:46:29.216Z",
"complete": true,
"etag": "7qDc9jBurptfmrAxr",
"path": "/file-upload/6542e355a2f73c7460e18ef6/2023-11-01_21-13-38.snagx",
"progress": 1,
"token": "eAD959d9A8",
"uploadedAt": "2023-11-01T23:46:29.196Z",
"uploading": false,
"url": "http://localhost:3000/file-upload/6542e355a2f73c7460e18ef6/2023-11-01_21-13-38.snagx",
"typeGroup": "application",
"user": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.john",
"name": "Test John"
}
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}Unauthorized
{
"success": false,
"error": "You must be logged in to do this."
}