Class PokerogueAdminApi

Hierarchy (View Summary)

ApiBase
- PokerogueAdminApi

Index

Constructors

Properties

base ERR_GENERIC ERR_USERNAME_NOT_FOUND

Methods

doFetch doGet doPost linkUnlinkRequest searchAccount toUrlSearchParams

Constructors

constructor

new PokerogueAdminApi(base: string): PokerogueAdminApi
Parameters
- base: string
Returns PokerogueAdminApi
Inherited from ApiBase.constructor
- Defined in src/plugins/api/api-base.ts:15

Properties

`Protected` `Readonly`base

base: string

`Readonly`ERR_GENERIC

ERR_GENERIC: string = "There was an error"

`Readonly`ERR_USERNAME_NOT_FOUND

ERR_USERNAME_NOT_FOUND: string = "Username not found!"

Methods

`Protected`doFetch

doFetch(path: string, config: RequestInit): Promise<Response>
A generic request helper.
Parameters
- path: string
  The path to send the request to.
- config: RequestInit
  The request RequestInit | Configuration.
Returns Promise<Response>
Inherited from ApiBase.doFetch
- Defined in src/plugins/api/api-base.ts:65

`Protected`doGet

doGet(path: string): Promise<Response>
Send a GET request.
Parameters
- path: string
  The path to send the request to.
Returns Promise<Response>
Inherited from ApiBase.doGet
- Defined in src/plugins/api/api-base.ts:25

`Protected`doPost

doPost<D = undefined>(
    path: string,
    bodyData?: D,
    dataType?: DataType,
): Promise<Response>
Send a POST request.
Type Parameters
- D = undefined
Parameters
- path: string
  THe path to send the request to.
- OptionalbodyData: D
  The body-data to send.
- dataType: DataType = "json"
  The data-type of the bodyData.
Returns Promise<Response>
Inherited from ApiBase.doPost
- Defined in src/plugins/api/api-base.ts:35

linkUnlinkRequest

linkUnlinkRequest(
    mode: AdminUiHandlerServiceMode,
    service: AdminUiHandlerService,
    params: GoogleRequest | DiscordRequest,
): Promise<null | string>
Link or unlink a third party service to/from a user account
Parameters
- mode: AdminUiHandlerServiceMode
  The mode, either "Link" or "Unlink"
- service: AdminUiHandlerService
  The third party service to perform the action with
- params: GoogleRequest | DiscordRequest
  The parameters for the user to perform the action on
Returns Promise<null | string>
null if successful, otherwise an error message
- Defined in src/plugins/api/pokerogue-admin-api.ts:20

searchAccount

searchAccount(
params: SearchAccountRequest,
): Promise<[data?: SearchAccountResponse, error?: string]>
Search an account.
Parameters
- params: SearchAccountRequest
  The SearchAccountRequest to send
Returns Promise<[data?: SearchAccountResponse, error?: string]>
an array of SearchAccountResponse and error. Both can be undefined
- Defined in src/plugins/api/pokerogue-admin-api.ts:50

`Protected`toUrlSearchParams

toUrlSearchParams<D extends Record<string, any>>(data: D): URLSearchParams
Helper to transform data to URLSearchParams Any key with a value of undefined will be ignored. Any key with a value of null will be included.
Type Parameters
- D extends Record<string, any>
Parameters
- data: D
  the data to transform to URLSearchParams
Returns URLSearchParams
a URLSearchParams representaton of data
Inherited from ApiBase.toUrlSearchParams
- Defined in src/plugins/api/api-base.ts:87