Difference between revisions of "Bot Playground/Commands/login"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Initiates bot login sequence.</onlyinclude> <syntaxhighlight lang="javascript"> Bot.login(location); </syntaxhighlight> {{API C...") |
|||
Line 20: | Line 20: | ||
{{API Variables Table End}} | {{API Variables Table End}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{{NavMenu}} | {{NavMenu}} | ||
__NOTOC__ | __NOTOC__ |
Revision as of 21:17, 2 July 2016
Initiates bot login sequence.
Bot.login(location);
Reference
This command accepts the following parameters:
Variable | Required | Description
| |
---|---|---|---|
Input: | |||
location | optional | The initial location to login. Leave blank for previous location.
Format: Region name/X/Y/Z Use HOME instead of location to send the bot home (see examples below). | |
Output: | |||
Function returns a Promise with the following data: | |||
success | bool | true if command completed successfully | |
error | string | error string if command has failed |