add link to impulses |
m fix types |
||
| Line 4: | Line 4: | ||
|Inputs= | |Inputs= | ||
[ | [ | ||
{"Name":"*", "Type":" | {"Name":"*", "Type":"AsyncCall"}, | ||
{"Name":"Path", "Type":"String"}, | {"Name":"Path", "Type":"String"}, | ||
{"Name":"VariableOwnerId", "Type":"String"} | {"Name":"VariableOwnerId", "Type":"String"} | ||
| Line 10: | Line 10: | ||
|Outputs= | |Outputs= | ||
[ | [ | ||
{"Name":"OnRequest", "Type":" | {"Name":"OnRequest", "Type":"SyncResumption"}, | ||
{"Name":"OnDone", "Type":" | {"Name":"OnDone", "Type":"Call"}, | ||
{"Name":"OnFail", "Type":" | {"Name":"OnFail", "Type":"Call"}, | ||
{"Name":"Value", "Type":"Dummy"} | {"Name":"Value", "Type":"Dummy"} | ||
] | ] | ||
| Line 18: | Line 18: | ||
== Inputs == <!--T:3--> | == Inputs == <!--T:3--> | ||
=== * ([[Impulses#ASync| | === * ([[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. | ||
| Line 35: | Line 35: | ||
== Outputs == <!--T:3--> | == Outputs == <!--T:3--> | ||
=== OnDone ([[Impulses| | === OnDone ([[Impulses|Call]]) === | ||
The impulse during which Value will have the read data. | The impulse during which Value will have the read data. | ||
=== OnFail ([[Impulses| | === 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. | ||
=== OnRequest ([[Impulses#ASync| | === OnRequest ([[Impulses#ASync|SyncResumption]] (Async)) === | ||
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. | 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. | ||
[[Category:ProtoFlux:Variables:Cloud]] | [[Category:ProtoFlux:Variables:Cloud]] | ||
Revision as of 21:18, 9 February 2024
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"
Value (Sudo-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 DataModelStore`1 to keep it for longer than the impulse.
Examples: ColorX, float3, String, DateTime.
Outputs
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.
OnRequest (SyncResumption (Async))
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.