Class APIRequestBuilder Abstract

Hierarchy

APIRequestBuilder
- DroidAPIRequestBuilder
- OsuAPIRequestBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new APIRequestBuilder(): APIRequestBuilder

Returns APIRequestBuilder

Methods

addParameter

addParameter(param: string, value: string | number): APIRequestBuilder

- Defined in osu-base/src/utils/APIRequestBuilder.ts:164
Adds a parameter to the builder.

Parameters
- param: string
  
  The parameter to add.
- value: string | number
  
  The value to add for the parameter.
Returns APIRequestBuilder

buildURL

buildURL(): string

- Defined in osu-base/src/utils/APIRequestBuilder.ts:89
Builds the URL to request the API.

Returns string

removeParameter

removeParameter(param: string): APIRequestBuilder

- Defined in osu-base/src/utils/APIRequestBuilder.ts:174
Removes a parameter from the builder.

Parameters
- param: string
  
  The parameter to remove.
Returns APIRequestBuilder

sendRequest

sendRequest(): Promise<RequestResponse>

- Defined in osu-base/src/utils/APIRequestBuilder.ts:125
Sends a request to the API using built parameters.

If the request fails, it will be redone 5 times.

Returns Promise<RequestResponse>

Abstract setEndpoint

setEndpoint(endpoint: DroidAPIEndpoint | OsuAPIEndpoint): APIRequestBuilder

- Defined in osu-base/src/utils/APIRequestBuilder.ts:74
Sets the API endpoint.

Parameters
- endpoint: DroidAPIEndpoint | OsuAPIEndpoint
  
  The endpoint to set.
Returns APIRequestBuilder

setRequireAPIkey

setRequireAPIkey(requireAPIkey: boolean): APIRequestBuilder

- Defined in osu-base/src/utils/APIRequestBuilder.ts:81
Sets if this builder includes the API key in the request URL.

Parameters
- requireAPIkey: boolean
  
  Whether or not to include the API key in the request URL.
Returns APIRequestBuilder

Generated using TypeDoc