Class PlayerApi

PlayerApi - object-oriented interface

Export

PlayerApi

Hierarchy

BaseAPI
- PlayerApi

Index

Constructors

constructor

new PlayerApi(configuration?, basePath?, axios?): PlayerApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PlayerApi
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

banControllerCreate

banControllerCreate(banCreateDTO?, options?): Promise<AxiosResponse<BanOutputDTOAPI, any>>
Create a new ban, creating a ban via the API will always make it takaro managed. Required permissions: MANAGE_PLAYERS
Parameters
- OptionalbanCreateDTO: BanCreateDTO
  BanCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanOutputDTOAPI, any>>
Summary
Ban player

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18967

banControllerDelete

banControllerDelete(id, options?): Promise<AxiosResponse<APIOutput, any>>
Unban player. This will remove the ban from Takaro and the gameserver(s) Required permissions: MANAGE_PLAYERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Unban player

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18981

banControllerGetOne

banControllerGetOne(id, options?): Promise<AxiosResponse<BanOutputDTOAPI, any>>
Get a single ban Required permissions: READ_PLAYERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanOutputDTOAPI, any>>
Summary
Get a single ban

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18995

banControllerSearch

banControllerSearch(banSearchInputDTO?, options?): Promise<AxiosResponse<BanOutputArrayDTOAPI, any>>
Search for bans Required permissions: READ_PLAYERS
Parameters
- OptionalbanSearchInputDTO: BanSearchInputDTO
  BanSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanOutputArrayDTOAPI, any>>
Summary
Search for bans

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19009

banControllerUpdate

banControllerUpdate(id, banUpdateDTO?, options?): Promise<AxiosResponse<BanOutputDTOAPI, any>>
Update an existing ban, updating a ban via the API will always make it takaro managed. Required permissions: MANAGE_PLAYERS
Parameters
- id: string
- OptionalbanUpdateDTO: BanUpdateDTO
  BanUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanOutputDTOAPI, any>>
Summary
Update ban

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19024

playerControllerAssignRole

playerControllerAssignRole(id, roleId, playerRoleAssignChangeDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
Parameters
- id: string
- roleId: string
- OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO
  PlayerRoleAssignChangeDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Assign role

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19040

playerControllerGetMe

playerControllerGetMe(options?): Promise<AxiosResponse<PlayerMeOutputDTO, any>>
Get the player that is currently authenticated. This is a low-privilege route, returning limited data.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerMeOutputDTO, any>>
Summary
Get current player

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19058

playerControllerGetOne

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

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19072

playerControllerRemoveRole

playerControllerRemoveRole(id, roleId, playerRoleAssignChangeDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
Parameters
- id: string
- roleId: string
- OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO
  PlayerRoleAssignChangeDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove role

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19088

playerControllerSearch

playerControllerSearch(playerSearchInputDTO?, options?): Promise<AxiosResponse<PlayerOutputArrayDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- OptionalplayerSearchInputDTO: PlayerSearchInputDTO
  PlayerSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19107

Class PlayerApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlayerApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

banControllerCreate

Parameters

Returns Promise<AxiosResponse<BanOutputDTOAPI, any>>

Summary

Throws

Memberof

banControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

banControllerGetOne

Parameters

Returns Promise<AxiosResponse<BanOutputDTOAPI, any>>

Summary

Throws

Memberof

banControllerSearch

Parameters

Returns Promise<AxiosResponse<BanOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

banControllerUpdate

Parameters

Returns Promise<AxiosResponse<BanOutputDTOAPI, any>>

Summary

Throws

Memberof

playerControllerAssignRole

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

playerControllerGetMe

Parameters

Returns Promise<AxiosResponse<PlayerMeOutputDTO, any>>

Summary

Throws

Memberof

playerControllerGetOne

Parameters

Returns Promise<AxiosResponse<PlayerOutputWithRolesDTOAPI, any>>

Summary

Throws

Memberof

playerControllerRemoveRole

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

playerControllerSearch

Parameters

Returns Promise<AxiosResponse<PlayerOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration