pocketbase library
Multi-platform Future-based library for interacting with the PocketBase API.
Classes
- 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.).
- AuthAlertConfig
- Response DTO of a single collection auth alert config.
- AuthMethodMFA
- Response DTO of mfa auth method option.
- AuthMethodOAuth2
- Response DTO of oauth2 auth method option.
- AuthMethodOTP
- Response DTO of otp auth method option.
- AuthMethodPassword
- Response DTO of password/identity auth method option.
- 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.
- BatchResult
- Response DTO of a single batch request result.
- BatchService
- The service that handles the Batch/transactional APIs.
- CollectionField
- Response DTO of a single collection schema field.
- CollectionModel
- Response DTO of a single collection model.
- CollectionService
- The service that handles the Collection APIs.
- EmailTemplateConfig
- Response DTO of a single collection email template config.
- 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.
- MFAConfig
- Response DTO of a single collection mfa auth config.
- OAuth2Config
- Response DTO of a single collection oauth2 auth config.
- OTPConfig
- Response DTO of a single collection otp auth config.
- OTPResponse
- Response DTO of a otp request response.
- PasswordAuthConfig
- Response DTO of a single collection password auth config.
- 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.
- SettingsService
- The service that handles the Settings APIs.
- SubBatchService
- TokenConfig
- Response DTO of a single collection token config.
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.