Class PlayerOnGameServerApi

PlayerOnGameServerApi - object-oriented interface

Export

PlayerOnGameServerApi

Hierarchy

BaseAPI
- PlayerOnGameServerApi

Index

Constructors

constructor

new PlayerOnGameServerApi(configuration?, basePath?, axios?): PlayerOnGameServerApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PlayerOnGameServerApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

playerOnGameServerControllerAddCurrency

playerOnGameServerControllerAddCurrency(gameServerId, playerId, playerOnGameServerSetCurrencyInputDTO?, options?): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
Parameters
- gameServerId: string
- playerId: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Summary
Add currency

Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19773

playerOnGameServerControllerDeductCurrency

playerOnGameServerControllerDeductCurrency(gameServerId, playerId, playerOnGameServerSetCurrencyInputDTO?, options?): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
Parameters
- gameServerId: string
- playerId: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Summary
Deduct currency

Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19794

playerOnGameServerControllerGetOne

playerOnGameServerControllerGetOne(gameServerId, playerId, options?): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- gameServerId: string
- playerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19819

playerOnGameServerControllerSearch

playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?, options?): Promise<AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- OptionalplayerOnGameServerSearchInputDTO: PlayerOnGameServerSearchInputDTO
  PlayerOnGameServerSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19833

playerOnGameServerControllerSetCurrency

playerOnGameServerControllerSetCurrency(gameServerId, playerId, playerOnGameServerSetCurrencyInputDTO?, options?): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
Parameters
- gameServerId: string
- playerId: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Summary
Set currency

Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19852

playerOnGameServerControllerTransactBetweenPlayers

playerOnGameServerControllerTransactBetweenPlayers(gameServerId, sender, receiver, playerOnGameServerSetCurrencyInputDTO?, options?): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
Parameters
- gameServerId: string
- sender: string
- receiver: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Summary
Transact between players

Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19874

Class PlayerOnGameServerApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlayerOnGameServerApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

playerOnGameServerControllerAddCurrency

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Summary

Throws

Memberof

playerOnGameServerControllerDeductCurrency

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Summary

Throws

Memberof

playerOnGameServerControllerGetOne

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Summary

Throws

Memberof

playerOnGameServerControllerSearch

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

playerOnGameServerControllerSetCurrency

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Summary

Throws

Memberof

playerOnGameServerControllerTransactBetweenPlayers

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration