CollectionHandler class

Store Collection Access (SCA) - Client-side protocol methods

Constructors

CollectionHandler()

Properties

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

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

createCollection(P2PStream stream, {required PeerId ownerPeerId, required String path, required String name, CollectionVisibility? visibility}) → Future<CollectionFrameResponse>
Create a new collection.
deleteCollection(P2PStream stream, {required PeerId ownerPeerId, required String path}) → Future<CollectionFrameResponse>
Delete a collection
deleteCollectionItem(P2PStream stream, {required PeerId ownerPeerId, required String path, required String key}) → Future<CollectionFrameResponse>
Delete a collection item
getCollection(P2PStream stream, {required PeerId ownerPeerId, required String path}) → Future<CollectionFrameResponse>
Get collection metadata
getCollectionItem(P2PStream stream, {required PeerId ownerPeerId, required String path, required String key}) → Future<CollectionFrameResponse>
Get a single collection item by key
listCollectionKeys(P2PStream stream, {required PeerId ownerPeerId, required String path, int? limit, int? offset, String? cursor}) → Future<CollectionFrameResponse>
List keys in a collection
listCollections(P2PStream stream, {required PeerId ownerPeerId}) → Future<CollectionFrameResponse>
List all collections for an owner
putCollectionItem(P2PStream stream, {required PeerId ownerPeerId, required String path, required String key, required Uint8List content, String? ifMatch}) → Future<CollectionFrameResponse>
Put (create or update) a collection item
queryCollection(P2PStream stream, {required PeerId ownerPeerId, required String path, Map<String, dynamic>? filter, String? sortField, bool? sortAsc, int? limit, int? offset, String? cursor, bool wantTotal = false}) → Future<CollectionFrameResponse>
Query a collection with JSONB filter.
setCollectionVisibility(P2PStream stream, {required PeerId ownerPeerId, required String path, required CollectionVisibility visibility}) → Future<CollectionFrameResponse>
Set who may read a collection (client-side ACCESS with action "set").

Constants

protocolId → const String