Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BackendEndpoints

Gives access to all endpoints the api exposes

Hierarchy

  • BackendEndpoints

Index

Constructors

Methods

Constructors

constructor

  • Parameters

    • app: any

    Returns BackendEndpoints

Methods

cancelRequests

  • cancelRequests(): void

  • Cancels all requests

    Returns void

clearSession

  • clearSession(): void

  • Clears the session key, this effectively logs us out

    Returns void

connectSteam

  • connectSteam(ticket: any): any

  • Logins the user with steam and gets an authentication key

    Route: /noauth/login

    Parameters

    • ticket: any

    Returns any

deleteSavegame

  • deleteSavegame(key: any): any

  • Deletes a savegame

    Route: /savegame/delete/:key

    Parameters

    • key: any

      The savegame key

    Returns any

    .

fetchEssencePacks

  • fetchEssencePacks(): any

  • Get essence packs

    Route: /iap/essence/items

    Returns any

fetchGameserverList

  • fetchGameserverList(): any

  • Returns the list of gameservers

    Route: /mp/lobbyservers/:multiplayerVersion

    Returns any

fetchIapItems

  • fetchIapItems(): any

  • Get iap items

    Route: /iap/items

    Returns any

fetchLeaderboard

  • fetchLeaderboard(mode: any): any

  • Fetches the singleplayer leaderboard

    Route: /noauth/leaderboard

    Parameters

    • mode: any

      The mode, see the api for more details on valid parameters

    Returns any

    The leaderboard entries

fetchMultiplayerHistory

  • fetchMultiplayerHistory(): any

  • Fetches the mp history

    Route: /mp/history

    Returns any

fetchMultiplayerProfile

  • fetchMultiplayerProfile(): any

  • Fetches th mp user profile

    Route: /mp/profile

    Returns any

fetchProfile

  • fetchProfile(): any

  • Fetches the user profile and directly updates it

    Route: /user/profile

    Returns any

fetchSchema

  • fetchSchema(): any

  • Retrieves the application schema and updates the achievements and perks afterwards

    Route: /noauth/schema

    Returns any

fetchServerSavegame

  • fetchServerSavegame(key: any): any

  • Fetches the full dump of a given savegame from the server

    Route: /user/savegame/:key

    Parameters

    • key: any

      The savegame synchronization key

    Returns any

fetchServerSavegames

  • fetchServerSavegames(): any

  • Fetches all savegame ids and metadata from the server

    Route: /user/savegames

    Returns any

    The savegame metadata

isLoggedIn

  • isLoggedIn(): boolean

  • Returns if we are currently logged in

    Returns boolean

isRegistered

  • isRegistered(): boolean

  • Returns if we have an a ccount

    Returns boolean

login

  • login(): any

  • Logins the user, only works if we are registered. Sets the session key afterwards.

    Route: /noauth/login

    Returns any

markSavegameOver

  • markSavegameOver(key: any): any

  • Mark a savegame as game over

    Route: /savegame/gameover

    Parameters

    • key: any

      the sync key

    Returns any

performFakePurchase

  • performFakePurchase(productId: any): any

  • Performs a fake in app purchase and also updates the diamonds

    Route: /iap/fake

    Parameters

    • productId: any

    Returns any

purchaseEssencePack

  • purchaseEssencePack(packId: any): any

  • Attempt to purchase an essence pack

    Route: /iap/essence/purchase/:packId

    Parameters

    • packId: any

    Returns any

purchasePerk

  • purchasePerk(perkId: any): any

  • Attempts to unlock a given perk

    Route: /purchase/perk

    Parameters

    • perkId: any

    Returns any

register

  • register(playerName: any, recaptchaToken: any): any

  • Attempts to rgisters the user with the given playername

    Route: /noauth/register

    Parameters

    • playerName: any

      The players desired name

    • recaptchaToken: any

      The recaptcha token

    Returns any

    The authentication key for the player

requestAccountRecovery

  • requestAccountRecovery(email: any): any

  • Sends a recovery token to the given account email

    Route: /noauth/recover-account

    Parameters

    • email: any

    Returns any

requestEmailLink

  • requestEmailLink(email: any, receiveNews: any): any

  • Links an email to the users account

    Route: /user/link-email

    Parameters

    • email: any
    • receiveNews: any

    Returns any

requestEmailUnlink

  • requestEmailUnlink(): any

  • Unlinks the email from the users account

    Route: /user/unlink-email

    Returns any

requestFreeCoins

  • requestFreeCoins(category: any): any

  • Requests to gain free coins for social media following

    Route: /iap/freecoins

    Parameters

    • category: any

    Returns any

    The new auth key on success

requestNameChange

  • requestNameChange(name: any): any

  • Requests to gain free coins for social media following

    Route: /iap/freecoins

    Parameters

    • name: any

    Returns any

    The new auth key on success

requestRecoveryTokenUsage

  • requestRecoveryTokenUsage(token: any, email: any): any

  • Requests the use of a given token

    Route: /noauth/use-recovery-token

    Parameters

    • token: any
    • email: any

      The supplied email

    Returns any

    The new auth key on success

resolveLobbyToken

  • resolveLobbyToken(token: any): any

  • Attempts to resolve a lobby token

    Route: /mp/resolve-token

    Parameters

    • token: any

    Returns any

steamAttemptPurchase

  • steamAttemptPurchase(itemId: any): any

  • STEAM: Attempt purchase

    Route: /iap/steam/purchase/:item

    Parameters

    • itemId: any

    Returns any

steamAttemptPurchaseFinalize

  • steamAttemptPurchaseFinalize(orderId: any): any

  • STEAM: Attempt to finalize order

    Route: /iap/steam/finalize/:orderId

    Parameters

    • orderId: any

    Returns any

togglePerkEnabled

  • togglePerkEnabled(perkId: any, enabled?: boolean): any

  • Toggles a given perk

    Route: /user/toggle-perk

    Parameters

    • perkId: any
    • Default value enabled: boolean = true

    Returns any

updateSavegame

  • updateSavegame(data: any): any

  • Updates a given savegame

    Route: /savegame/update

    Parameters

    • data: any

      The serialized data

    Returns any

    The new synchronization key.

xsollaGetShopToken

  • xsollaGetShopToken(itemId: any): any

  • XSOLLA: Get items

    Route: /iap/xsolla/get-token/:item

    Parameters

    • itemId: any

    Returns any