common/dev.pubgkt.http

Package-level declarations

Types

PublicRequestPolicy

@PubgktInternal

data object PublicRequestPolicy : RequestPolicy

RequestPolicy

@PubgktInternal

sealed interface RequestPolicy

UnauthorizedException

class UnauthorizedException : Exception

Thrown when the PUBG API returns HTTP 401 (Unauthorized). Provide a working API Key.

Properties

json

@PubgktInternal

val json: Json

Functions

deserialize

@PubgktInternal

suspend fun <T> HttpResponse.deserialize(deserializer: JsonApiResourceDeserializer<T>): T

Deserializes a JSON:API single-resource response ({"data": { … }}) into T.

deserializeList

@PubgktInternal

suspend fun <T> HttpResponse.deserializeList(deserializer: JsonApiResourceDeserializer<T>): List<T>

Deserializes a JSON:API collection response ({"data": [ … ]}) into List<T>.

get

@PubgktInternal

suspend fun HttpClient.get(urlString: String, policy: RequestPolicy): HttpResponse

Performs an HTTP GET request to urlString applying only policy.

@PubgktInternal

suspend fun HttpClient.get(urlString: String, platform: Platform = Platform.STEAM, policy: RequestPolicy = DefaultRequestPolicy): HttpResponse

Performs an HTTP GET request to urlString using a Platform shard.

@PubgktInternal

suspend fun HttpClient.get(urlString: String, platformRegion: PlatformRegion = PlatformRegion.PC_SA, policy: RequestPolicy = DefaultRequestPolicy): HttpResponse

Performs an HTTP GET request to urlString using a PlatformRegion shard.

@PubgktInternal

suspend fun HttpClient.get(urlString: String, platform: Platform = Platform.STEAM, policy: RequestPolicy = DefaultRequestPolicy, block: HttpRequestBuilder.() -> Unit = {}): HttpResponse

Performs an HTTP GET request to urlString using a Platform shard, and applies additional request customization via block.