DirectusWebSocketSubscription<T extends DirectusData> class

Constructors

DirectusWebSocketSubscription({required String uid, List<String>? fields, Filter? filter, List<SortProperty>? sort, int? limit, int? offset, String? onCreate(Map<String, dynamic>)?, String? onUpdate(Map<String, dynamic>)?, String? onDelete(Map<String, dynamic>)?, dynamic onError(dynamic)?, dynamic onDone()?})

Properties

collection → String
no setter
collectionMetadata → CollectionMetadata
no setter
fields → List<String>?
final
fieldsToJson → List<String>
no setter
filter → Filter?
final
filterToJson → Map<String, dynamic>?
no setter
hashCode → int
The hash code for this object.
no setterinherited
limit → int?
final
offset → int?
final
onCreate ↔ String? Function(Map<String, dynamic>)?
getter/setter pair
onDelete ↔ String? Function(Map<String, dynamic>)?
getter/setter pair
onDone ↔ dynamic Function()?
Function to be called when the subscription has finished receiving events. This can happen in two cases: 1 - The unsubcribe event has been sent and acknowledged for this subscription. 2 - The socket holding this subscription has been closed.
getter/setter pair
onError ↔ dynamic Function(dynamic)?
Function to be called when an error occurs on the socket level. Each subscription on that socket will call this function if provided.
getter/setter pair
onUpdate ↔ String? Function(Map<String, dynamic>)?
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sort → List<SortProperty>?
final
specificClass → ClassMirror
no setter
uid → String
final

Methods

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

Operators

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