Class: BotManager

BotManager

new BotManager()

Creates a new BotManager instance.
Source:

Methods

addEndpoint(method, url, callback)

Add an API Endpoint (via webserver) at chosen location.
Parameters:
Name Type Description
method
url
callback
Source:

apiEndpoint(method, url, callback)

Add an API Endpoint (via webserver) at chosen location.
Parameters:
Name Type Description
method
url
callback
Deprecated:
  • Yes
Source:

botLookup(keyData, callback)

Lookup a botAccount using the username of the bot or the index of the bot in the list.
Parameters:
Name Type Description
keyData
callback
Deprecated:
  • Yes
Source:

chooseRandomBot() → {*}

Choose a random bot (not checked if online)
Deprecated:
  • Yes
Source:
Returns:
Type
*

deleteAccount(botAccount, unregisterCallback)

Parameters:
Name Type Description
botAccount BotAccount The bot chosen as part of the random choice
unregisterCallback callback A callback returned with possible errors
Source:

errorDebug(message)

Post/log an error-type message
Parameters:
Name Type Description
message string Error message to log
Source:

findBot(keyData, callback) → {*}

Lookup a botAccount using the username of the bot or the index of the bot or even the SteamID2, SteamID3, and SteamID64
Parameters:
Name Type Description
keyData
callback
Source:
Returns:
Type
*

getAccounts() → {Array}

Retrieve accounts registered within the instance
Source:
Returns:
- Array of BotAccount objects
Type
Array

infoDebug(message)

Post/log an informational message.
Parameters:
Name Type Description
message string Informational message to log
Source:

logDebug(message)

Post/log an debug message.
Parameters:
Name Type Description
message string debug message to log
Source:

randomBot() → {*}

Choose a random bot - with filters Will simple loop until it find a bot that meets all filters - otherwise it will just randomly choose one. Make sure to set filters based on your use-case. filters: in array of Strings 'canTrade' - Bot can access the API and can trade 'steamID:XX' - where XX is replaced with SteamID2, SteamID3, or SteamID64 or even TradeLink
Source:
Returns:
Type
*

registerAccount(username, password, options, callback)

Register an account for use with the steam-bot-manager
Parameters:
Name Type Description
username
password
options
callback
Source:

removeEndpoint(method, url, callback)

Remove an API Endpoint (via webserver) at chosen location.
Parameters:
Name Type Description
method
url
callback
Source: