Sporran class Null safety

This is the main Sporran API class.

Please read the usage and interface documentation supplied for further details.

Constructors

Sporran(SporranInitialiser initialiser)
Construction.

Properties

autoSync bool
Manual control of sync(). [...]
read / write
clientCompleter JsonObjectLite
Completion function
write-only
completionResponse JsonObjectLite?
read-only
dbName String
read-only
hashCode int
The hash code for this object. [...]
read-only, inherited
lawndart → Store
Lawndart database
read-only
lawnIsOpen bool
Lawndart database is open
read-only
manualNotificationControl bool
Manual notification control
read-only
online bool
On/Offline indicator
read / write
onReady Stream?
Ready event
read-only
pendingDeleteSize int
Pending delete queue size
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
wilt Wilt
Wilt database
read-only

Methods

bulkCreate(Map<String, JsonObjectLite> docList) Future
Bulk document create. [...]
delete(String id, [String rev = '']) Future
Delete a document. [...]
deleteAttachment(String id, String attachmentName, [String rev = '']) Future
Delete an attachment. Revision can be null if offline. If the parameters are invalid null is returned.
get(String id, [String rev = '']) Future
Get a document If the parameters are invalid null is returned.
getAllDocs({bool includeDocs = false, int limit = 10, String startKey = '', String endKey = '', List<String> keys = const <String>[], bool descending = false}) Future<JsonObjectLite>
Get all documents. [...]
getAttachment(String id, String attachmentName) Future
Get an attachment. If the parameters are invalid null is returned.
getDatabaseInfo() Future<JsonObjectLite>
Get information about the database. [...]
login(String user, String password) → void
Login [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
put(String id, JsonObjectLite document, [String rev = '']) Future
Update document. [...]
putAttachment(String id, dynamic attachment) Future
Put attachment [...]
startChangeNotifications() → void
Start change notification manually
stopChangeNotifications() → void
Stop change notification manually
sync() → void
Synchronise local storage and CouchDb when we come online or on demand. [...]
toString() String
A string representation of this object. [...]
inherited

Operators

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

Constants

bulkCreatec → const String
'bulk_create'
dbInfoc → const String
'db_info'
deleteAttachmentc → const String
'delete_attachment'
deletec → const String
'delete'
getAllDocsc → const String
'get_all_docs'
getAttachmentc → const String
'get_attachment'
getc → const String
'get'
putAttachmentc → const String
'put_attachment'
putc → const String
Method constants
'put'