RapidGatorApi class

Main client for interacting with the RapidGator API.

Constructors

RapidGatorApi.new({Dio? dio})
Creates a new instance of the RapidGator API client.

Properties

hashCode int
The hash code for this object.
no setterinherited
maximum_list_size int
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
token String?
no setter

Methods

changeFileMode({required String fileId, required int mode}) Future<FileInfo>
Changes file mode.
changeFolderMode({required String folderId, required int mode}) Future<FolderInfo>
Changes folder mode.
Checks the status of download links.
copyFile({required List<String> fileIds, required String destinationFolderId}) Future<Map<String, dynamic>>
Copies a file.
copyFolder({required String folderId, required String destinationFolderId}) Future<Map<String, dynamic>>
Copies a folder.
createFolder({required String name, String? parentFolderId}) Future<FolderInfo>
Creates a folder.
Creates a one-time download link.
createRemoteUpload({required String url}) Future<Map<String, dynamic>>
Creates a remote upload job.
deleteFile({required List<String> fileIds}) Future<Map<String, dynamic>>
Deletes a file.
deleteFolder({required String folderId}) Future<Map<String, dynamic>>
Deletes a folder.
deleteRemoteUpload({required String jobId}) Future<Map<String, dynamic>>
Deletes a remote upload job.
downloadFile({required String fileId}) Future<String>
Downloads a file.
emptyTrashCan({List<String>? fileIds}) Future<Map<String, dynamic>>
Empties the trash can.
getFileInfo({required String fileId}) Future<FileInfo>
Retrieves file information.
getFolderContent({String? folderId, int page = 1, int perPage = 500, String sortColumn = 'name', String sortDirection = 'ASC'}) Future<List<FolderInfo>>
Retrieves folder content.
getFolderInfo({String? folderId}) Future<FolderInfo>
Retrieves folder information.
getOneTimeLinkInfo({List<String>? linkIds}) Future<List<OneTimeLinkInfo>>
Retrieves one-time link info.
getRemoteUploadInfo({String? jobId}) Future<List<RemoteUploadJob>>
Retrieves remote upload job info.
getTrashCanContent({String? folderId, int page = 1, int perPage = 500, String sortColumn = 'name', String sortDirection = 'ASC'}) Future<List<TrashCanContent>>
Retrieves trash can content.
getUploadInfo({required String uploadId}) Future<Map<String, dynamic>>
Retrieves upload session info.
getUserInfo() Future<UserInfo>
Retrieves user information.
login({required String email, required String password, String? twoFactorCode}) Future<void>
Logs in the user and sets the access token.
moveFile({required List<String> fileIds, required String destinationFolderId}) Future<Map<String, dynamic>>
Moves a file.
moveFolder({required String folderId, required String destinationFolderId}) Future<Map<String, dynamic>>
Moves a folder.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
renameFile({required String fileId, required String newName}) Future<FileInfo>
Renames a file.
renameFolder({required String folderId, required String newName}) Future<FolderInfo>
Renames a folder.
restoreTrashCanFiles({List<String>? fileIds}) Future<Map<String, dynamic>>
Restores files from the trash can.
setToken(String token) → void
toString() String
A string representation of this object.
inherited
uploadFile({required String name, required String hash, required int size, String? folderId}) Future<Map<String, dynamic>>
Uploads a file.

Operators

operator ==(Object other) bool
The equality operator.
inherited