UpdateVerbBuilder class

Update builder generates a command to update value for a key atKey in the secondary server of sharedBy. Use getBuilder method if you want to convert command to a builder.

  • Setting a public value for the key 'phone'

  • When isPublic is set to true, throws InvalidAtKeyException if isLocal is set to true or sharedWith is populated

 var updateBuilder = UpdateVerbBuilder()
 ..isPublic=true
 ..key='phone'
 ..sharedBy='bob'
 ..value='+1-1234';

  • @bob setting a value for the key 'phone' to share with @alice

  • When sharedWith is populated, throws InvalidAtKeyException if isLocal or isPublic is set to true

 var updateBuilder = UpdateVerbBuilder()
 ..sharedWith=’alice’
 ..key='phone'
 ..sharedBy='bob'
 ..value='+1-5678';

  • Creating a local key for storing data that does not sync

  • When isLocal is set to true, throws InvalidAtKeyException if isPublic is set to true or sharedWith is populated

 var updateBuilder = UpdateVerbBuilder()
                     ..isLocal = true
                     ..key = 'preferences'
                     ..sharedBy = '@bob'
                     ..value = jsonEncode(myPrefObj)
Implemented types

Constructors

UpdateVerbBuilder.new()

Properties

atKey ↔ String?
See AtKey.key
getter/setter pairinherited
atKeyObj ↔ AtKey
Represents the AtKey instance to populate the verb builder data
getter/setter pairinherited
ccd ↔ bool?
See Metadata.ccd
getter/setter pairinherited
dataSignature ↔ String?
See Metadata.dataSignature
getter/setter pairinherited
encAlgo ↔ String?
See Metadata.encAlgo
getter/setter pairinherited
encKeyName ↔ String?
See Metadata.encKeyName
getter/setter pairinherited
encoding ↔ String?
See Metadata.encoding
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setteroverride
isBinary ↔ bool?
See Metadata.isBinary
getter/setter pairinherited
isEncrypted ↔ bool?
See Metadata.isEncrypted
getter/setter pairinherited
isJson ↔ bool
getter/setter pair
isLocal ↔ bool
See AtKey.isLocal
getter/setter pair
isPublic ↔ bool
See Metadata.isPublic
getter/setter pairinherited
isTextMessageEncrypted ↔ bool?
See Metadata.isEncrypted
getter/setter pairinherited
ivNonce ↔ String?
See Metadata.ivNonce
getter/setter pairinherited
metadata → Metadata
no setterinherited
operation ↔ String?
getter/setter pair
pubKeyChecksum ↔ String?
See Metadata.pubKeyCS
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sharedBy ↔ String?
See AtKey.sharedBy
getter/setter pairinherited
sharedKeyEncrypted ↔ String?
See Metadata.sharedKeyEnc
getter/setter pairinherited
sharedKeyStatus ↔ String?
See Metadata.sharedKeyStatus
getter/setter pairinherited
sharedWith ↔ String?
See AtKey.sharedWith
getter/setter pairinherited
skeEncAlgo ↔ String?
See Metadata.skeEncAlgo
getter/setter pairinherited
skeEncKeyName ↔ String?
See Metadata.skeEncKeyName
getter/setter pairinherited
ttb ↔ int?
See Metadata.ttb
getter/setter pairinherited
ttl ↔ int?
See Metadata.ttl
getter/setter pairinherited
ttr ↔ int?
See Metadata.ttr
getter/setter pairinherited
value ↔ dynamic
Value of the key typically in string format. Images, files, etc., must be converted to unicode string before storing.
getter/setter pair

Methods

buildCommand() → String
Build the @ command to be sent to remote secondary for execution.
override
buildCommandForMeta() → String
buildKey() → String
Get the string representation (e.g. @bob:city.address.my_app@alice) of the key for which this update command is being built.
checkParams() → bool
Checks whether all params required by the verb builder are set. Returns false if required params are not set.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
validateKey() → void
Validates the AtKey
inherited

Operators

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

Static Methods

getBuilder(String command) → UpdateVerbBuilder?