AGConnectCloudDB class

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

closeCloudDBZone({required AGConnectCloudDBZone zone}) Future<void>
You can invoke this method to close one Cloud DB zone object opened on the device.
createObjectType() Future<void>
This method is called to create or modify an object type, define a set of storage objects, and store data generated by the application.
deleteCloudDBZone({required String zoneName}) Future<void>
You can invoke this method to delete a Cloud DB zone object that is no longer used on the device. You can delete Cloud DB zone only after Cloud DB zone is closed.
disableNetwork({required String zoneName}) Future<void>
You can invoke this method to disable the data synchronization on the local device. After data synchronization is disabled, data will not be synchronized between the device and the cloud.
enableNetwork({required String zoneName}) Future<void>
You can invoke this method to open the data synchronization on the local device. Data can be synchronized between the device and the cloud only after data synchronization is enabled.
getCloudDBZoneConfigs() Future<List<AGConnectCloudDBZoneConfig>>
You can call this method to obtain all CloudDBZoneConfig lists on the device.
initialize() Future<void>
You should call this method before calling all other methods.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDataEncryptionKeyChanged() Stream<bool?>
This method is called to register a listener for data key changes.
onEvent() Stream<String?>
This method is called to register the listener events.
openCloudDBZone({required AGConnectCloudDBZoneConfig zoneConfig, bool isAllowToCreate = true}) Future<AGConnectCloudDBZone>
You can invoke this API to create or open an object of a Cloud DB zone on the device. An object of a Cloud DB zone represents a unique data storage zone. An application supports a maximum of 4 Cloud DB zone on the device.
openCloudDBZone2({required AGConnectCloudDBZoneConfig zoneConfig, bool isAllowToCreate = true}) Future<AGConnectCloudDBZone>
You can invoke this API to create or open an object of a Cloud DB zone on the device. An object of a Cloud DB zone represents a unique data storage zone. An application supports a maximum of 4 Cloud DB zone on the device.
setUserKey({String userKey = '', String userReKey = '', bool needStrongCheck = false}) Future<void>
This method is called to set or modify the user password for Cloud DB full encryption. For the cache mode, you are advised to enable local database encryption on the device to ensure local data security. If the object type you create on the AppGallery Connect console contains encrypted fields but you do not use setUserKey() to set the user password, the data of this object type cannot be synchronized to the cloud and you cannot perform operations on the data of this object type on the cloud.
toString() String
A string representation of this object.
inherited
updateDataEncryptionKey() Future<void>
A data key used to encrypt user data and are automatically generated by the system. To prevent from being cracked when using one key for a long time, you can call this method to update the data key.

Operators

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

Static Methods

getInstance() AGConnectCloudDB