Built-in Functions

From SmartBots Developers Docs
Bot Playground
Revision as of 11:07, 23 June 2023 by NealB (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The basic built-in functions do not relate to bot functionality. Instead, they allow writing flexible scripts.

setTimeout(function() { console.log("Timer has fired!"); }, 3000);

Commands reference

Command Description

Script details

process.name Read-only property reflecting running script name.
process.release Read-only property reflecting the script release version (for Store-purchased scripts).

Program flow

process.exit Ends the execution of the program.
process.sleep Pauses a program execution.
Timer control Standard timer control routines of JavaScript: setTimeout, setInterval etc.

Persistent bot storage

localStorage.get Restores a string value from a persistent storage.
localStorage.set Puts a string value into a persistent storage.
localStorage.keys Returns the list of the available keys in a persistent storage.
localStorage.on Adds the event callback on localStorage.

User settings

userSettings.* Allows accessing the settings specified by the script user.

HTTP

http.get Retrieves data from a HTTP source.
http.post Retrieves data from a HTTP source using the POST method.
http.fetch Bot Playground/Built-in Functions/http.fetch

Debug

console.log Logs data to the runtime log.
console.error Logs data to the error log.