add impulse links |
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 11: | Line 11: | ||
|Outputs= | |Outputs= | ||
[ | [ | ||
{"Name":"OnRequest", "Type":" | {"Name":"OnRequest", "Type":"SyncResumption"}, | ||
{"Name":"OnDone", "Type":" | {"Name":"OnDone", "Type":"Call"}, | ||
{"Name":"OnFail", "Type":" | {"Name":"OnFail", "Type":"Call"} | ||
] | ] | ||
|}} | |}} | ||
== Inputs == <!--T:3--> | == Inputs == <!--T:3--> | ||
=== * ([[Impulses#ASync| | === * ([[Impulses#ASync|AsyncCall]]) === | ||
Will Write the cloud variable upon impulse. Is restricted by cloud variable rate limits. | Will Write 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 written the data. | The impulse during which Value will have written the 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. | 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. | ||
=== OnRequest ([[Impulses#ASync| | === OnRequest ([[Impulses#ASync|SyncResumption]] (Async)) === | ||
An async impulse sent when the node has sent the request for the value to be written. This can be used to chain more asynchronous calls together to happen in parallel like more writing to other variable definitions. | An async impulse sent when the node has sent the request for the value to be written. This can be used to chain more asynchronous calls together to happen in parallel like more writing to other variable definitions. | ||
[[Category:ProtoFlux:Variables:Cloud]] | [[Category:ProtoFlux:Variables:Cloud]] | ||
Revision as of 21:30, 9 February 2024
Inputs
* (AsyncCall)
Will Write 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 writing a value to the variable specified in Path.
Examples: "U-Frooxius", "U-Nexulan"
Value (Sudo-Generic)
The value you want to write to this cloud variable.
Examples: ColorX, float3, String, DateTime.
Outputs
OnDone (Call)
The impulse during which Value will have written the 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.
OnRequest (SyncResumption (Async))
An async impulse sent when the node has sent the request for the value to be written. This can be used to chain more asynchronous calls together to happen in parallel like more writing to other variable definitions.