common/dev.pubgkt

Package-level declarations

Types

BackoffStrategy

sealed interface BackoffStrategy

Controls the delay between retry attempts.

ExponentialBackoff

data class ExponentialBackoff(val base: Double = 2.0, val baseDelayMs: Long, val maxDelayMs: Long, val randomizationMs: Long) : BackoffStrategy

Applies exponential backoff between retry attempts.

enum GameMode : Enum<GameMode>

PUBG Game Mode used for leaderboards and stats

data object NoBackoff : BackoffStrategy

No delay between retry attempts. Retries are issued immediately.

data object NoRetry : RetryPolicy

Disables all retry behavior. Failed requests will propagate immediately.

enum Platform : Enum<Platform>

PUBG Platform shard

enum PlatformRegion : Enum<PlatformRegion>

PUBG Platform Region shard

class PubgApi @JvmOverloads constructor(apiKey: String, rateLimiter: RateLimiter = DelayRateLimiter(), retry: RetryPolicy = NoRetry)

Entry point for all PUBG API interactions.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS])

@RequiresOptIn(message = "This API is intended for internal use only.", level = RequiresOptIn.Level.ERROR)

annotation class PubgktInternal

Marks an API for internal use only.

data class Retry(val maxRetries: Int = 5, val backoff: BackoffStrategy = NoBackoff, val retryOnExceptions: List<KClass<out Throwable>> = emptyList()) : RetryPolicy

Enables automatic retries for failed HTTP requests.

sealed interface RetryPolicy

Defines the retry behavior for failed HTTP requests made by PubgApi.

data class Season(val id: String, val isCurrentSeason: Boolean, val isOffSeason: Boolean)

Functions

fun List<Season>.currentOrNull(): Season?

Returns the current season among a list of available Season or null.

suspend fun PubgApi.isUp(): Boolean

Returns the status of the PUBG API.

suspend fun PubgApi.seasons(platform: Platform = Platform.STEAM): List<Season>

Returns the list of available Season by platform.

suspend fun PubgApi.seasons(platformRegion: PlatformRegion = PlatformRegion.PC_SA): List<Season>

Returns the list of available Season by platform-region.