Skip to main content

Module models

Module models 

Source
Expand description

Common data models for the Cloudreve API v3

Structs§

ApiResponse
API response wrapper for v3 API
Aria2CreateRequest
Aria2 create download request for v3 API
Aria2DownloadInfo
Aria2 download progress info as reported by aria2c JSON-RPC, surfaced verbatim by Cloudreve v3 inside the info field of /aria2/downloading items. All fields are strings because aria2 itself emits them that way; consumers typically parse on demand.
Aria2DownloadingTask
In-flight aria2 task as returned by GET /aria2/downloading.
Aria2File
One file inside an aria2 task. For multi-file torrents Cloudreve v3 may expose more than one entry; for plain HTTP downloads there is exactly one.
Aria2FileUri
One source URI inside an aria2 file entry. Cloudreve v3 echoes aria2’s own shape.
Aria2FinishedTask
Finished aria2 task as returned by GET /aria2/finished.
CaptchaResponse
CAPTCHA response for v3 API
CopyObjectRequest
Copy object request for v3 API
CreateDirectoryRequest
Create directory request for v3 API
CreateFileRequest
Create file request for v3 API
DeleteObjectRequest
Delete object request for v3 API
DirectoryList
Directory listing response for v3 API
DownloadUrl
Download file response for v3 API
FileSource
File source information for v3 API
FileSourceRequest
File source request for v3 API
LoginRequest
Login request for v3 API
MoveObjectRequest
Move object request for v3 API
Object
File or folder object for v3 API
ObjectPropertyRequest
Object property request for v3 API
OtpLoginRequest
OTP login request for v3 API
Policy
Storage policy information for v3 API
Property
File or folder property for v3 API
RenameObjectRequest
Rename object request for v3 API
Share
Share link information for v3 API
ShareRequest
Share request for v3 API
SiteConfig
Site configuration for v3 API
SourceItems
Source items for object operations
StorageInfo
Storage information for v3 API
UploadFileRequest
Upload file request for v3 API
UploadSession
Upload session information for v3 API
User
User information for v3 API
UserGroup
User group information for v3 API
UserTask
One entry of the user’s task queue (/user/setting/tasks). Distinct from aria2 tasks: covers compression, decompression, recycle, transfer, etc.
UserTaskList
Paginated response for /user/setting/tasks.
WebdavAccount
WebDAV account information for v3 API