BackupService class

The service that handles the Backup and restore APIs.

Usually shouldn't be initialized manually and instead PocketBase.backups should be used.

Constructors

BackupService(PocketBase client)

Properties

client PocketBase
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

create(String basename, {Map<String, dynamic> body = const {}, Map<String, dynamic> query = const {}, Map<String, String> headers = const {}}) Future<void>
Initializes a new backup.
delete(String key, {Map<String, dynamic> body = const {}, Map<String, dynamic> query = const {}, Map<String, String> headers = const {}}) Future<void>
Deletes a single backup file.
getDownloadUrl(String token, String key, {Map<String, dynamic> query = const {}}) Uri
Builds a download url for a single existing backup using an admin file token and the backup file key.
getFullList({Map<String, dynamic> query = const {}, Map<String, String> headers = const {}}) Future<List<BackupFileInfo>>
Fetch all available app settings.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
restore(String key, {Map<String, dynamic> body = const {}, Map<String, dynamic> query = const {}, Map<String, String> headers = const {}}) Future<void>
Initializes an app data restore from an existing backup.
toString() String
A string representation of this object.
inherited
upload(MultipartFile file, {Map<String, dynamic> body = const {}, Map<String, dynamic> query = const {}, Map<String, String> headers = const {}}) Future<void>
Uploads an existing backup file.

Operators

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