Skip to content

CloudDB

Non-Visible component
Category Requires Version
Experimental API 21, Android 5.0 Lollipop 1

Overview

Non-visible component that communicates with CloudDB server to store and retrieve information.

Permissions

Events

CloudDB Error

Indicates that an error occurred while communicating with the CloudDB Redis server.

Params
message Text

Data Changed

Indicates that the data in the CloudDB project has changed Launches an event with the tag and value that have been updated.

Params
tag Text
value Any

First Removed

Event triggered by the "RemoveFirstFromList" function. The argument "value" is the object that was the first in the list, and which is now removed.

Params
value Any

Got Value

Indicates that a GetValue request has succeeded.

Params
tag Text
value Any

Tag List

Event triggered when we have received the list of known tags. Used with the "GetTagList" Function.

Params
value List

Methods

Append Value To List

Append a value to the end of a list atomically. If two devices use this function simultaneously, both will be appended and no data lost.

Params
tag Text
item To Add Any

Clear Tag

Remove the tag from CloudDB

Params
tag Text

Cloud Connected

Returns: Boolean

returns True if we are on the network and will likely be able to connect to the CloudDB server.

Get Tag List

Get the list of tags for this application. When complete a "TagList" event will be triggered with the list of known tags.

Get Value

Get the Value for a tag, doesn't return the value but will cause a GotValue event to fire when the value is looked up.

Params
tag Text
value If Tag Not There Any

Remove First From List

Return the first element of a list and atomically remove it. If two devices use this function simultaneously, one will get the first element and the the other will get the second element, or an error if there is no available element. When the element is available, the "FirstRemoved" event will be triggered.

Params
tag Text

Store Value

Store a value at a tag.

Params
tag Text
value To Store Any

Properties

Default Redis Server

Text ➖ Write - Designer

The Default Redis Server to use.

Project ID

Text ➖ Read - Designer Blocks

Gets the ProjectID for this CloudDB project.

Redis Port

Number Default: 6381 ➖ Read - Designer Blocks

The Redis Server port to use. Defaults to 6381

Redis Server

Text Default: DEFAULT ➖ Read - Designer Blocks

The Redis Server to use to store data. A setting of "DEFAULT" means that the MIT server will be used.

Token

Text ➖ Write - Designer

This field contains the authentication token used to login to the backed Redis server. For the "DEFAULT" server, do not edit this value, the system will fill it in for you. A system administrator may also provide a special value to you which can be used to share data between multiple projects from multiple people. If using your own Redis server, set a password in the server's config and enter it here.

Use SSL

Boolean Default: True ➖ Write - Designer

Set to true to use SSL to talk to CloudDB/Redis server. This should be set to True for the "DEFAULT" server.


Last update: November 9, 2022