pocketbase library

Multi-platform Future-based library for interacting with the PocketBase API.

Classes

AdminAuth
Response DTO of the admin authentication data.
AdminModel
Response DTO of a single admin model.
AdminService
The service that handles the Admin APIs.
AppleClientSecret
Response DTO of the Apple OAuth2 Client Secret response.
AsyncAuthStore
AsyncAuthStore is a pluggable AuthStore implementation that could be used with any external async persistent layer (shared_preferences, hive, local file, etc.).
AuthMethodProvider
Response DTO of a single OAuth2 provider.
AuthMethodsList
Response DTO of the allowed authentication methods.
AuthStore
Base authentication store management service that keep tracks of the authenticated User/Admin model and its token.
AuthStoreEvent
Event object that holds an AuthStore state.
BackupFileInfo
Response DTO of a backup file info entry.
BackupService
The service that handles the Backup and restore APIs.
BaseCrudService<M extends Jsonable>
Base generic crud service that is intented to be used by all other crud services.
CollectionModel
Response DTO of a single collection model.
CollectionService
The service that handles the Collection APIs.
ExternalAuthModel
Response DTO of a single ExternalAuth model.
FileService
The service that handles the File APIs.
HealthCheck
Response DTO of a health check.
HealthService
The service that handles the Health APIs.
Jsonable
Interface for JSON serializable classes.
LogModel
Response DTO of a single log model.
LogService
The service that handles the Log APIs.
LogStat
Response DTO of a single log statistic summary item.
PocketBase
The main PocketBase API client.
RealtimeService
The service that handles the Realtime APIs.
RecordAuth
Response DTO of the record authentication data.
RecordModel
Response DTO of a single record model.
RecordService
The service that handles the Record APIs.
RecordSubscriptionEvent
Response DTO of a single realtime subscription event.
ResultList<M extends Jsonable>
Response DTO of a generic paginated list.
SchemaField
Response DTO of a single collection schema field.
SettingsService
The service that handles the Settings APIs.

Constants

isWeb → const bool

Typedefs

ClearFunc = Future<void> Function()
ListItemFactory<M extends Jsonable> = M Function(Map<String, dynamic> item)
The factory function (eg. fromJson()) that will be used for a single item in a paginated list.
OAuth2UrlCallbackFunc = void Function(Uri url)
RecordSubscriptionFunc = void Function(RecordSubscriptionEvent e)
The definition of a realtime record subscription callback function.
SaveFunc = Future<void> Function(String data)
SubscriptionFunc = void Function(SseMessage e)
The definition of a realtime subscription callback function.
UnsubscribeFunc = Future<void> Function()

Exceptions / Errors

ClientException
An exception caused by an error in the PocketBase client.