Action
Action Editor
There are differences between Action Script descriptions and actions in desktop and mobile apps.
Here, we will explain important points regarding objects, built-in functions, and other elements that can be used in batch applications.
Object
Describes the objects that can be used in batch application action scripts.
| Object | Description |
|---|---|
| $param | In Batch, the contents specified in the parameters can be referenced as a $param object. |
| $global | Please refer to $global. |
| $const | Please refer to $const. |
| $fn | Built-in functions can be invoked. For a list of available functions, please refer to the table below. |
| $env | Please refer to $env |
Built-in function
This section describes the built-in functions that can be used in batch application action scripts.
| Built-in function | Description |
|---|---|
| $fn.getFile(path) | Please refer to $fn.getFile(path). |
| $fn.getFileNames(path) | Please refer to $fn.getFileNames(path) |
| $fn.putFile(path, parameters) | Please refer to $fn.putFile(path, parameters) |
| $fn.deleteFile(path) | Please refer to $fn.deleteFile(path) |
| $fn.getUsers(groupName?,option) | Please refer to $fn.getUsers(groupName?,option) |
| $fn.createUser(param) | Please refer to $fn.createUser(param) |
| $fn.updateUser(param) | Please refer to $fn.updateUser(param) |
| $fn.deleteUser(email) | Please refer to $fn.deleteUser(email) |
| $fn.exit(exitCode) | The job will end with the specified exit code. Argument: Exit code (numeric value) Return value：None Tips This built-in function is for batch scripts only. It cannot be used in actions. |
| $fn.resetPassword(param) | Please refer to $fn.resetPassword(param) |
| $fn.getGroups(option) | Please refer to $fn.getGroups(option) |
| $fn.createGroup(param) | Please refer to $fn.createGroup(param) |
| $fn.addUsers(param) | Please refer to $fn.addUsers(param) |
| $fn.removeUsers(param) | Please refer to $fn.removeUsers(param) |
| $fn.svf.oauth2.token() | Please refer to $fn.svf.oauth2.token() |
| $fn.svf.oauth2.revoke() | Please refer to $fn.svf.oauth2.revoke() |
| $fn.svf.artifacts.print() | Please refer to $fn.svf.artifacts.print() |
| $fn.svf.artifacts.info() | Please refer to $fn.svf.artifacts.info() |
| $fn.svf.artifacts.download() | Please refer to $fn.svf.artifacts.download() |
| $fn.svf.actions.status() | Please refer to $fn.svf.actions.status() |
| $fn.sendMail(param) | Please refer to $fn.sendMail(param) |
| $fn.csvToObject(csv) | Please refer to $fn.csvToObject(csv) |
| $fn.getPresignedUrl(path,options) | Please refer to $fn.getPresignedUrl(path,options) |
| $fn.listUsersByEmail(email,option) | Please refer to $fn.listUsersByEmail(email,option) |
| $fn.listUsersByName(name,option) | Please refer to $fn.listUsersByName(name,option) |