System
103 posts tagged with "System"
.action-help
The .action-help action displays action help screen. It belongs to the help category within the system area.
Action Syntax
.action-help "text"
.action-help $variable
Valid sizes
Examples
// Basic Usage
.action-help "actionname"
// Using Variables
// Display dynamic content from variables
.action-help $actionmame
.action-list
The .action-list action shows a list of actions (search result). It belongs to the help category within the system area.
Action Syntax
.action-list $variable
Valid sizes
Examples
// Basic Usage
.action-list $Ggroupname
.error-line
The .error-line action displays an error on the app screen. It belongs to the error category within the system area.
Action Syntax
.error-line "text"
.error-line !set:icon "text"
Examples
// Basic Usage
.error-line "the network request timed out"
.fullscreen-error
The .fullscreen-error action a full screen error component. It belongs to the error category within the system area.
Action Syntax
.fullscreen-error "text"
.fullscreen-error !set:icon "text"
Tags
continue
continue with app after acknowledgement (default)
reload
reload/restart the app after acknowledgement
goto
block name to goto after acknowledgement
Examples
// Basic Usage
.fullscreen-error "This-is-an-error"
.paste-background
The .paste-background action full screen input to capture a pasted background image. It belongs to the clipboard category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = .paste-background
Valid sizes
Examples
// Basic Usage
.paste-background
.rhappsody
The .rhappsody action shows rhappsody logo. It belongs to the platform category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
.rhappsody
.rhyme-example
The .rhyme-example action an example rhyme snippet with output. It belongs to the rhyme category within the system area.
Action Syntax
.rhyme-example blk
Valid sizes
Examples
// Basic Usage
.rhyme-example `source`
.rhyme-live
The .rhyme-live action a live rhyme scratch pad with output. It belongs to the rhyme category within the system area.
Action Syntax
.rhyme-live blk
.rhyme-live "text" blk
Valid sizes
Tags
height
output height in pixels. default is 100
Examples
// Basic Usage
.rhyme-live `source`
.rhyme-source
The .rhyme-source action displays a formatted block of rhyme code. It belongs to the rhyme category within the system area.
Action Syntax
.rhyme-source $variable
Valid sizes
Examples
// Basic Usage
.rhyme-source $var
.turnstile
The .turnstile action renders Cloudflare CATCHPA solution widget. It belongs to the security category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
light
renders widget in light mode (default)
dark
renders widget in dark mode
Examples
// Basic Usage
.turnstile
.upload-csv
The .upload-csv action Creates a button to let users upload CSV files from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-csv +imagetag
Return Value
This function returns a
$result = .upload-csv
Valid sizes
Examples
// Basic Usage
$response = .upload-csv %icontag
.upload-file
The .upload-file action Creates a button to let users upload any file from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-file +imagetag
Return Value
This function returns a
$result = .upload-file
Valid sizes
Examples
// Basic Usage
$response = .upload-file %icontag
.upload-file-input
The .upload-file-input action Creates a labeled file upload button with icon and text. It belongs to the file category within the system area.
Action Syntax
.upload-file-input "text"
.upload-file-input !set:icon "text"
Valid sizes
Examples
// Basic Usage
$any = .upload-file-input "Label"
.upload-image
The .upload-image action Creates a button to let users upload and resize images from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-image +imagetag
Return Value
This function returns a
$result = .upload-image
Valid sizes
Examples
// Basic Usage
$response = .upload-image %icontag
.upload-json
The .upload-json action Creates a button to let users upload JSON files from their device. It belongs to the upload category within the system area.
Action Syntax
.upload-json +imagetag
Return Value
This function returns a
$result = .upload-json
Valid sizes
Examples
// Basic Usage
$response = .upload-json %icontag
+paste-image
The +paste-image action pastes an image into the clipboard. It belongs to the clipboard category within the system area.
Action Syntax
+paste-image E
Return Value
This function returns a
$result = +paste-image
Valid sizes
Examples
// Basic Usage
$image = +paste-image *target
allow-dynamic-actions
The allow-dynamic-actions action allowed dynamic action referencing. It belongs to the actions category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
allow-dynamic-actions
app
The app action defines the app name, along with key auth key. It belongs to the appauth category within the system area.
Action Syntax
app @reference
app @reference "text"
Valid sizes
Examples
// Basic Usage
app @agan
app-host
The app-host action defines an allowed host for the app. The rhapp.app domain is allowed by default. It belongs to the appauth category within the system area.
Action Syntax
app-host https://...
Valid sizes
Examples
// Basic Usage
app-host https://www.acme.com
app-private
The app-private action sets app private key. It belongs to the appauth category within the system area.
Action Syntax
app-private privatekey
Valid sizes
Examples
// Basic Usage
app-private privatekey
app-public
The app-public action defines an app public auth key. It belongs to the appauth category within the system area.
Action Syntax
app-public publickey
Valid sizes
Examples
// Basic Usage
app-public publickey
break
The break action breaks / halts app execution for debugging. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
break
clear-client
The clear-client action clears out rhappsody client info from the device. It belongs to the client category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
clear-client
compile
The compile action compiles rhyme source code using compiler (init-compiler required first). It belongs to the compiler category within the system area.
Action Syntax
compile $variable
compile "text"
compile blk
Return Value
This function returns a
$result = compile
Valid sizes
Examples
// Basic Usage
$response = compile $source
conditional
The conditional action a very special op that is a conditional attach/execution of a SINGLE compiled op to its previous op. It belongs to the flow category within the system area.
Action Syntax
conditional
This action takes no parameters and is used as a bare command.
Examples
// Basic Usage
conditional
contains
The contains action contains actions. It belongs to the logicfn category within the system area.
Action Syntax
contains "text"
contains $variable
contains 123
Return Value
This function returns a
$result = contains
Valid sizes
Examples
// Basic Usage
$boolean = contains "text"
continue
The continue action continues running the app block (usually) after a wait. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
continue
create-key
The create-key action creates a randon offical encrpytion key - 32 characters long. It belongs to the secrets category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = create-key
Valid sizes
Examples
// Basic Usage
create-key
decode-secret
The decode-secret action test function to decode a secret. It belongs to the secrets category within the system area.
Action Syntax
decode-secret "text" with $variable
Return Value
This function returns a
$result = decode-secret
Valid sizes
Examples
// Basic Usage
$text = decode-secret "SECRETNAME" with $key
decrypt
The decrypt action general decryption. It belongs to the secrets category within the system area.
Action Syntax
decrypt "text"
decrypt $variable
decrypt "text" with $variable
decrypt $variable with $variable
Return Value
This function returns a
delay
The delay action delays or sleeps for a specified amount of time. It belongs to the exec category within the system area.
Action Syntax
delay 30m
delay $variable
Valid sizes
Examples
// Basic Usage
delay 3s
// Using Variables
// Display dynamic content from variables
delay $time
delete-public-user-data
The delete-public-user-data action delete user data item (public). It belongs to the users category within the system area.
Action Syntax
delete-public-user-data $variable
Return Value
This function returns a
$result = delete-public-user-data
Valid sizes
Examples
// Basic Usage
$response = delete-public-user-data $varname
delete-user-data
The delete-user-data action delete user data item (private). It belongs to the users category within the system area.
Action Syntax
delete-user-data $variable
Return Value
This function returns a
$result = delete-user-data
Valid sizes
Examples
// Basic Usage
$response = delete-user-data $varname
dynamic-action
The dynamic-action action hidden command that is a dynamic action “carrier” action. It belongs to the actions category within the system area.
Action Syntax
dynamic-action "text"
dynamic-action 123
dynamic-action 123 123
dynamic-action $variable
dynamic-action $variable $variable
dynamic-action [file]
dynamic-action "text" [file]
Valid sizes
Examples
// Basic Usage
dynamic-action "placeholder"
// Using Variables
// Display dynamic content from variables
dynamic-action $varname
encrypt
The encrypt action encrypts data. It belongs to the secrets category within the system area.
Action Syntax
encrypt "text"
encrypt $variable
encrypt "text" with $variable
encrypt $variable with $variable
Return Value
This function returns a
endconditional
The endconditional action :end to end multiline conditional. It belongs to the flow category within the system area.
Action Syntax
endconditional
This action takes no parameters and is used as a bare command.
Examples
// Basic Usage
endconditional
equals
The equals action tests for equality. It belongs to the logicfn category within the system area.
Action Syntax
equals 123
equals "text"
equals $variable
equals true|false
Return Value
This function returns a
$result = equals
Valid sizes
Examples
// Basic Usage
$boolean = equals 10
goto
The goto action Jumps to a different block in your app. It belongs to the goto category within the system area.
Action Syntax
goto [file]
goto $variable
Valid sizes
Tags
no-clear
prevents clearing the screen when jumping
Examples
// Basic Usage
goto [block-name]
// Using Variables
// Display dynamic content from variables
goto $block-variable
have
The have action checks for variables existance. It belongs to the logicfn category within the system area.
Action Syntax
have $variable
Return Value
This function returns a
$result = have
Valid sizes
Examples
// Basic Usage
$boolean = have $varname
host-call
The host-call action call a function at the host / parent level. The environment is usually the browser to server javascript run time global environment. It belongs to the exec category within the system area.
Action Syntax
host-call "text"
host-call "text" $variable
host-call "text" $variable $variable
Return Value
This function returns a
if
The if action if statement. It belongs to the logic category within the system area.
Action Syntax
if $variable = 123
if $variable is 123
if $variable = "text"
if $variable is "text"
if $variable = $variable
if $variable is $variable
if $variable = true|false
if $variable is true|false
if $variable < 123
if $variable < $variable
if $variable <= 123
if $variable <= $variable
if $variable > 123
if $variable > $variable
if $variable >= 123
if $variable >= $variable
if $variable contains "text"
if $variable contains $variable
if $variable starts-with "text"
if $variable starts-with $variable
if $variable ends-with "text"
if $variable ends-with $variable
if $variable is not "text"
if $variable is not 123
if $variable is not true|false
if $variable is not $variable
if missing $variable
if have $variable
Examples
// Basic Usage
if $foo = 10
init-all
The init-all action initalize all. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Tags
auth
client
images
Examples
// Basic Usage
init-all
init-auth
The init-auth action initial auth. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-auth
init-client
The init-client action initialized rhappsody client. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-client
init-compiler
The init-compiler action initializes compiler (must be loaded already). It belongs to the compiler category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = init-compiler
Valid sizes
Tags
version
specific version. default is latest
Examples
// Basic Usage
init-compiler
init-help
The init-help action initialized inline rhappsody/rhyme help actions. It belongs to the help category within the system area.
Action Syntax
init-help
This action takes no parameters and is used as a bare command.
Valid sizes
Examples
// Basic Usage
init-help
init-images
The init-images action initializes / loads any saved images. It belongs to the init category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
init-images
is-date
The is-date action checks if a value is in date format (yyyy-mm-dd). It belongs to the logicfn category within the system area.
Action Syntax
is-date $variable
Return Value
This function returns a
$result = is-date
Valid sizes
Examples
// Basic Usage
$boolean = is-date $varname
is-greater-than
The is-greater-than action checks if a value is greater than another value. It belongs to the logicfn category within the system area.
Action Syntax
is-greater-than $variable $variable
is-greater-than $variable 123
is-greater-than $variable "text"
Return Value
This function returns a
is-group
The is-group action checks to see if value is a group (array). It belongs to the logicfn category within the system area.
Action Syntax
is-group $variable
Return Value
This function returns a
$result = is-group
Valid sizes
Examples
// Basic Usage
$boolean = is-group $varname
is-item
The is-item action checks to see if value is an item (object). It belongs to the logicfn category within the system area.
Action Syntax
is-item $variable
Return Value
This function returns a
$result = is-item
Valid sizes
Examples
// Basic Usage
$boolean = is-item $varname
is-less-than
The is-less-than action checks if a value is less than another value. It belongs to the logicfn category within the system area.
Action Syntax
is-less-than $variable $variable
is-less-than $variable 123
is-less-than $variable "text"
Return Value
This function returns a
is-number
The is-number action checks to see if value is a number. It belongs to the logicfn category within the system area.
Action Syntax
is-number $variable
Return Value
This function returns a
$result = is-number
Valid sizes
Examples
// Basic Usage
$boolean = is-number $varname
is-time
The is-time action checks if a value is in time format (hh:mm). It belongs to the logicfn category within the system area.
Action Syntax
is-time $variable
Return Value
This function returns a
$result = is-time
Valid sizes
Examples
// Basic Usage
$boolean = is-time $varname
list-actions
The list-actions action gets a full list of rhappsody actions. It belongs to the help category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-actions
Valid sizes
Tags
set
filter by set
area
filter by area
Examples
// Basic Usage
list-actions
list-actionsets
The list-actionsets action returns a complete list of action sets. It belongs to the help category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-actionsets
Valid sizes
Examples
// Basic Usage
list-actionsets
list-areas
The list-areas action returns a list of action areas. It belongs to the help category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-areas
Valid sizes
Examples
// Basic Usage
list-areas
list-compilers
The list-compilers action lists cached compilers. It belongs to the compiler category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-compilers
Valid sizes
Examples
// Basic Usage
list-compilers
list-dynamic-actions
The list-dynamic-actions action lists the names of dynamic-actions. It belongs to the actions category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
list-dynamic-actions
list-public-user-data
The list-public-user-data action lists user data (public). It belongs to the users category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-public-user-data
Valid sizes
Examples
// Basic Usage
list-public-user-data
list-secrets
The list-secrets action lists all secrets for the current app. It belongs to the secrets category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-secrets
Valid sizes
Examples
// Basic Usage
list-secrets
list-user-data
The list-user-data action lists user data (private). It belongs to the users category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = list-user-data
Valid sizes
Examples
// Basic Usage
list-user-data
load-binary-file
The load-binary-file action Loads binary data from a URL into a variable. It belongs to the file category within the system area.
Action Syntax
load-binary-file https://...
load-binary-file $variable
Return Value
This function returns a
$result = load-binary-file
Valid sizes
Examples
// Basic Usage
$varrec = load-binary-file https://someurl
load-compiler
The load-compiler action loads WASM compiler binary. It belongs to the compiler category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Return Value
This function returns a
$result = load-compiler
Valid sizes
Tags
version
specifies version. default is latest. can be beta, dev, local, or specific number
load-json-file
The load-json-file action Loads JSON data from a URL into a variable. It belongs to the file category within the system area.
Action Syntax
load-json-file https://...
load-json-file $variable
Return Value
This function returns a
$result = load-json-file
Valid sizes
Examples
// Basic Usage
$varrec = load-json-file https://someurl
load-public-user-data
The load-public-user-data action loads user data (public). It belongs to the users category within the system area.
Action Syntax
load-public-user-data $variable
Return Value
This function returns a
$result = load-public-user-data
Valid sizes
Examples
// Basic Usage
$varrec = load-public-user-data $varname
load-text-file
The load-text-file action Loads text content from a URL into a variable. It belongs to the file category within the system area.
Action Syntax
load-text-file https://...
load-text-file $variable
Return Value
This function returns a
$result = load-text-file
Valid sizes
Examples
// Basic Usage
$varrec = load-text-file https://someurl
load-user-data
The load-user-data action loads user data (private). It belongs to the users category within the system area.
Action Syntax
load-user-data $variable
Return Value
This function returns a
$result = load-user-data
Valid sizes
Examples
// Basic Usage
$varrec = load-user-data $varname
logic
The logic action logic operations. It belongs to the logic category within the system area.
Action Syntax
logic $variable and $variable
logic $variable or $variable
logic $variable xor $variable
Return Value
This function returns a
missing
The missing action logic fn to test for missing variable. It belongs to the logicfn category within the system area.
Action Syntax
missing $variable
Return Value
This function returns a
$result = missing
Valid sizes
Examples
// Basic Usage
$boolean = missing $varname
not
The not action a negation action for logic statements like if and when. It belongs to the logic category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
not
not-equals
The not-equals action not equals. It belongs to the logicfn category within the system area.
Action Syntax
not-equals 123
not-equals "text"
not-equals $variable
not-equals true|false
Return Value
This function returns a
$result = not-equals
Valid sizes
Examples
// Basic Usage
$boolean = not-equals 10
register-actionset
The register-actionset action registers/loads a remote actionset. It belongs to the actions category within the system area.
Action Syntax
register-actionset https://...
Return Value
This function returns a
$result = register-actionset
Valid sizes
Examples
// Basic Usage
$response = register-actionset https://actionsetrepo
reload
The reload action reloads/refreshes browser window. Restarts app from scratch. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
reload
remove-secret
The remove-secret action removes a secret for an app. It belongs to the secrets category within the system area.
Action Syntax
remove-secret 123
remove-secret $variable
Return Value
This function returns a
$result = remove-secret
Valid sizes
Examples
// Basic Usage
$item = remove-secret 12
repeat
The repeat action repeat an action or group of actions multiple times. It belongs to the flow category within the system area.
Action Syntax
repeat 123 times
repeat $variable times
Tags
index-name
use this name as the index variable. Default is $index
Examples
// Basic Usage
repeat 10 times
// Using Variables
// Display dynamic content from variables
repeat $foo times
reset-client
The reset-client action resets the client. Note: this will clear all associated profile information. It belongs to the client category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
reset-client
resume
The resume action resumes as flow (after wait/break/pause). It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
resume
return
The return action return values. It belongs to the exec category within the system area.
Action Syntax
return $variable
return "text"
return 123
return true|false
return IT
Valid sizes
Examples
// Basic Usage
return $varname
run
The run action runs a block one time. It belongs to the exec category within the system area.
Action Syntax
run [file]
run $variable
Valid sizes
Examples
// Basic Usage
run [block]
// Using Variables
// Display dynamic content from variables
run $blockvar
save-public-user-data
The save-public-user-data action saves user data (public). It belongs to the users category within the system area.
Action Syntax
save-public-user-data $variable
save-public-user-data $variable as $variable
Return Value
This function returns a
$result = save-public-user-data
Valid sizes
Examples
// Basic Usage
$response = save-public-user-data $varname
save-user-data
The save-user-data action saves user data (private). It belongs to the users category within the system area.
Action Syntax
save-user-data $variable
save-user-data $variable as $variable
Return Value
This function returns a
$result = save-user-data
Valid sizes
Examples
// Basic Usage
$response = save-user-data $varname
secret
The secret action define secret value. It belongs to the secrets category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
secret
server-run
The server-run action runs specified block on server/remote. It belongs to the exec category within the system area.
Action Syntax
server-run [file]
Return Value
This function returns a
$result = server-run
Valid sizes
Examples
// Basic Usage
$response = server-run [record-order]
set-app-title
The set-app-title action sets the app title string. It belongs to the config category within the system area.
Action Syntax
set-app-title "text"
Valid sizes
Examples
// Basic Usage
set-app-title "title"
set-css-variable
The set-css-variable action sets a CSS variable. It belongs to the advanced category within the undefined area.
Action Syntax
set-css-variable $variable "text" // sets Rhappsody CSS variable
set-css-variable $variable $variable // sets variable to other variable Value
Examples
// Basic Usage
set-css-variable $cssvarname "value" // sets Rhappsody CSS variable
set-debug-ui
The set-debug-ui action sets UI debug mode. It belongs to the config category within the system area.
Action Syntax
set-debug-ui true|false
Valid sizes
Examples
// Basic Usage
set-debug-ui true
set-dev-mode
The set-dev-mode action sets dev mode. It belongs to the platform category within the system area.
Action Syntax
set-dev-mode true|false
Valid sizes
Examples
// Basic Usage
set-dev-mode true
set-mock-mode
The set-mock-mode action sets mock mode. It belongs to the platform category within the system area.
Action Syntax
set-mock-mode true|false
Valid sizes
Examples
// Basic Usage
set-mock-mode true
set-private-key
The set-private-key action sets app private key. It belongs to the appauth category within the system area.
Action Syntax
set-private-key "text"
Valid sizes
Examples
// Basic Usage
set-private-key "rh_private_appkey"
set-public-key
The set-public-key action sets public key. Required for secrets and users support. It belongs to the appauth category within the system area.
Action Syntax
set-public-key "text"
Valid sizes
Examples
// Basic Usage
set-public-key "publickey"
set-secret
The set-secret action sets a secret key for the current app. It belongs to the secrets category within the system area.
Action Syntax
set-secret $variable "text"
Valid sizes
Examples
// Basic Usage
set-secret $openapikey "ffff"
set-start-block
The set-start-block action Defines which block your app starts running from. It belongs to the flow category within the system area.
Action Syntax
set-start-block [file]
Valid sizes
Examples
// Basic Usage
set-start-block [block]
su-account
The su-account action retrieves the details of an account. It belongs to the platform category within the system area.
Action Syntax
su-account "text"
Return Value
This function returns a
$result = su-account
Valid sizes
Examples
// Basic Usage
$response = su-account "email"
su-accounts
The su-accounts action returns a summary of all platform accounts. It belongs to the platform category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
su-accounts
su-platform
The su-platform action enables platform app. It belongs to the platform category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
su-platform
unshield
The unshield action unshield a shielded value. It belongs to the shield category within the system area.
Action Syntax
unshield $variable
Valid sizes
Examples
// Basic Usage
$any = unshield $value
use
The use action loads platform plugin or component and makes available for use. It belongs to the platform category within the system area.
Action Syntax
use "text"
Valid sizes
Examples
// Basic Usage
use "plugin"
user
The user action defines an app user. It belongs to the users category within the system area.
Action Syntax
user @reference 123
user @reference 123 user
user @reference 123 admin
user @reference 123 manager
user @reference 123 editor
Valid sizes
Tags
public
makes the user name and role visible on client side app
user-data
The user-data action stub action for all server user data ACTIONS. It belongs to the users category within the system area.
Action Syntax
user-data $variable
Return Value
This function returns a
$result = user-data
Valid sizes
Examples
// Basic Usage
$response = user-data $varname
wait
The wait action wait for interaction before continuing. It belongs to the exec category within the system area.
Action Syntax
This action accepts various parameters. See the examples below for usage patterns.
Valid sizes
Examples
// Basic Usage
wait
waitfor
The waitfor action waits for a value from an input into a variable. It belongs to the exec category within the system area.
Action Syntax
waitfor
This action takes no parameters and is used as a bare command.
Description: waits for input
Valid sizes
Examples
// Basic Usage
waitfor
when
The when action when - a synonymn for if. It belongs to the logic category within the system area.
Action Syntax
when $variable
Valid sizes
Examples
// Basic Usage
when $var