LobbyApi | ogame-bot-api

The LobbyApi is used to login, get servers informations and load the GameApi

Hierarchy

LobbyApi

Index

Methods

Methods

getAccounts

getAccounts(): Promise<Account[]>

- Defined in Api/lobby/LobbyApi.ts:57
Returns Promise<Account[]>

Returns the user accounts. The user accounts are the differents server which the user is already connected at least one time

listServers

listServers(): Promise<Server[]>

- Defined in Api/lobby/LobbyApi.ts:65
Returns Promise<Server[]>

Returns the list of all ogame servers.

loadGame

loadGame(account: Account): Promise<GameApi>

- Defined in Api/lobby/LobbyApi.ts:93
Load the GameApi

Parameters
- account: Account
  
  The selected account to load the game
Returns Promise<GameApi>

login

login(email: string, password: string): Promise<void>

- Defined in Api/lobby/LobbyApi.ts:30
Parameters
- email: string
  
  Email of the ogame account
- password: string
  
  Password of the ogame account
Returns Promise<void>

me

me(): Promise<User>

- Defined in Api/lobby/LobbyApi.ts:48
Returns Promise<User>

Returns the gloabl user informations

selectLastPlayedAccount

selectLastPlayedAccount(): Promise<Account>

- Defined in Api/lobby/LobbyApi.ts:82
Select last account played by the user

Returns Promise<Account>

Generated using TypeDoc