No edit summary |
Fixed visual. Fixed the arrangement of the output descriptions. Moved the value description from input to output. Added a link to DataModelStore. |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{#Invoke:ProtoFlux|GenerateUI | |||
|Name=Read Cloud Variable | |||
|Category=Cloud | |||
{{#Invoke: | |||
Name=Read Cloud Variable | |||
|Inputs= | |Inputs= | ||
[ | [ | ||
{"Name":"*", "Type":" | {"Name":"*", "Type":"AsyncCall"}, | ||
{"Name":"Path", "Type":"String"}, | {"Name":"Path", "Type":"String"}, | ||
{"Name":"VariableOwnerId", "Type":"String"} | {"Name":"VariableOwnerId", "Type":"String"} | ||
| Line 12: | Line 10: | ||
|Outputs= | |Outputs= | ||
[ | [ | ||
{"Name":"OnRequest", "Type":" | {"Name":"OnRequest", "Type":"SyncResumption"}, | ||
{"Name":"OnDone", "Type":" | {"Name":"OnDone", "Type":"Continuation"}, | ||
{"Name":"OnFail", "Type":" | {"Name":"OnFail", "Type":"Continuation"}, | ||
{"Name":"Value", "Type":"Dummy"} | {"Name":"Value", "Type":"Dummy"} | ||
] | ] | ||
|}} | |}} | ||
Read Cloud Variable is a node that is able to read cloud variables that are already defined. For more information on how to define the permissions/security of cloud variables, and how to create them, see [[Cloud Variables]] | |||
== * ( | |||
== Inputs == <!--T:3--> | |||
=== * ([[Impulses#ASync|AsyncCall]]) === | |||
Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits. | Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits. | ||
== Path (String) == | === Path ([[Type:String|String]]) === | ||
The definition owner + "." + The variable name. | The definition owner + "." + The variable name. | ||
<br>Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" | <br>Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" | ||
== VariableOwnerId (String) == | === VariableOwnerId ([[Type:String|String]]) === | ||
The id of the person you want to read the value for the variable definition specified in Path. | The id of the person you want to read the value for the variable definition specified in Path. | ||
<br>Examples: "U-Frooxius", "U-Nexulan" | <br>Examples: "U-Frooxius", "U-Nexulan" | ||
== OnDone ( | == Outputs == <!--T:3--> | ||
=== OnRequest ([[Impulses#Async|SyncResumption]]) === | |||
Sent when the node has sent the request for the value to be read. This can be used to chain more asynchronous calls together to happen in parallel like more reading from other variable definitions. | |||
=== OnDone ([[Impulses|Call]]) === | |||
The impulse during which Value will have the read data. | The impulse during which Value will have the read data. | ||
== OnFail ( | === OnFail ([[Impulses|Call]]) === | ||
The impulse caused if the variable hit an error. including but not limited to: Invalid Path, improper permissions for the variable definition in Path, Invalid userID, UserID has not made a definition for the variable definition in Path. | The impulse caused if the variable hit an error. including but not limited to: Invalid Path, improper permissions for the variable definition in Path, Invalid userID, UserID has not made a definition for the variable definition in Path. | ||
== | === Value (Pseudo-generic) === | ||
The value you read for the user in VariableOwnerID in the variable definition defined in Path. This only exists during the OnDone Impulse. Write the output to a [[ProtoFlux:Data_Model_Store|Data Model Store]] to keep it for longer than the impulse. | |||
<br>Examples: [[Type:ColorX|ColorX]], [[Type:Float3|float3]], [[Type:String|String]], [[Type:DateTime|DateTime]]. | |||
[[Category:ProtoFlux:Variables:Cloud]] | |||
Latest revision as of 19:27, 19 May 2024
Read Cloud Variable is a node that is able to read cloud variables that are already defined. For more information on how to define the permissions/security of cloud variables, and how to create them, see Cloud Variables
Inputs
* (AsyncCall)
Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits.
Path (String)
The definition owner + "." + The variable name.
Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool"
VariableOwnerId (String)
The id of the person you want to read the value for the variable definition specified in Path.
Examples: "U-Frooxius", "U-Nexulan"
Outputs
OnRequest (SyncResumption)
Sent when the node has sent the request for the value to be read. This can be used to chain more asynchronous calls together to happen in parallel like more reading from other variable definitions.
OnDone (Call)
The impulse during which Value will have the read data.
OnFail (Call)
The impulse caused if the variable hit an error. including but not limited to: Invalid Path, improper permissions for the variable definition in Path, Invalid userID, UserID has not made a definition for the variable definition in Path.
Value (Pseudo-generic)
The value you read for the user in VariableOwnerID in the variable definition defined in Path. This only exists during the OnDone Impulse. Write the output to a Data Model Store to keep it for longer than the impulse.
Examples: ColorX, float3, String, DateTime.