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:22

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: DoFetchConfig): Promise<Response>
A generic request helper.
Parameters
- path: string
  The path to send the request to
- config: DoFetchConfig
  The request configuration
Returns Promise<Response>
Inherited from ApiBase.doFetch
- Defined in src/plugins/api/api-base.ts:86

`Protected`doGet

doGet(path: string): Promise<Response>
Send an HTTP 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:32

`Protected`doPost

doPost(
    path: string,
    bodyData?: string | Record<string, any>,
    dataType?: "json",
): Promise<Response>
Send an HTTP POST request.
Parameters
- path: string
  The path to send the request to
- OptionalbodyData: string | Record<string, any>
  The body-data to send; will be stringified if needed
- OptionaldataType: "json"
  (Default "json") The type of data to send
Returns Promise<Response>
Inherited from ApiBase.doPost
- Defined in src/plugins/api/api-base.ts:42
doPost(
    path: string,
    bodyData: Record<string, any>,
    dataType: "form-urlencoded",
): Promise<Response>
Send an HTTP POST request.
Parameters
- path: string
  The path to send the request to
- bodyData: Record<string, any>
  The body-data to send; will be stringified if needed
- dataType: "form-urlencoded"
  (Default "json") The type of data to send
Returns Promise<Response>
Inherited from ApiBase.doPost
- Defined in src/plugins/api/api-base.ts:49

linkUnlinkRequest

linkUnlinkRequest(
    mode: AdminUiHandlerServiceMode,
    service: AdminUiHandlerService,
    params: DiscordRequest | GoogleRequest,
): Promise<string | null>
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: DiscordRequest | GoogleRequest
  The parameters for the user to perform the action on
Returns Promise<string | null>
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(data: Record<string, any>): 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.
Parameters
- data: Record<string, any>
  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:109