Difference between revisions of "Bot Playground/Built-in Functions"

From SmartBots Developers Docs
Jump to: navigation, search
 
(5 intermediate revisions by one other user not shown)
Line 9: Line 9:
  
 
{{API_Table_start|Command|Description}}
 
{{API_Table_start|Command|Description}}
 +
{{API_Group|Script details}}
 +
{{API_Entry|HTTP Bot Command|process.name}}
 +
{{API_Entry|HTTP Bot Command|process.release}}
  
 
{{API_Group|Program flow}}
 
{{API_Group|Program flow}}
−
{{API_Entry|HTTP Bot Command|exit}}
+
{{API_Entry|HTTP Bot Command|process.exit}}
−
{{API_Entry|HTTP Bot Command|sleep}}
+
{{API_Entry|HTTP Bot Command|process.sleep}}
 
{{API_Entry|HTTP Bot Command|Timer control}}
 
{{API_Entry|HTTP Bot Command|Timer control}}
  
Line 20: Line 23:
 
{{API_Entry|HTTP Bot Command|localStorage.keys}}
 
{{API_Entry|HTTP Bot Command|localStorage.keys}}
 
{{API_Entry|HTTP Bot Command|localStorage.on}}
 
{{API_Entry|HTTP Bot Command|localStorage.on}}
 +
 +
{{API_Group|User settings}}
 +
{{API_Entry|HTTP Bot Command|userSettings.*}}
  
 
{{API_Group|HTTP}}
 
{{API_Group|HTTP}}
 
{{API_Entry|HTTP Bot Command|http.get}}
 
{{API_Entry|HTTP Bot Command|http.get}}
 
{{API_Entry|HTTP Bot Command|http.post}}
 
{{API_Entry|HTTP Bot Command|http.post}}
 +
{{API_Entry|HTTP Bot Command|http.fetch}}
  
 
{{API_Group|Debug}}
 
{{API_Group|Debug}}

Latest revision as of 11:07, 23 June 2023

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.



Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=Bot_Playground/Built-in_Functions&oldid=2205"