igdbclient-core/ru.pixnews.igdbclient

Package-level declarations

Types

IgdbClient

interface IgdbClient

IGDB Client which allows you to call the IGDB API methods.

IgdbDumpApi

interface IgdbDumpApi

IgdbDumpApi allows you to get CSV Data Dumps

IgdbEndpoint

open class IgdbEndpoint<out R : Any>(val endpoint: String, val resultParser: (ApicalypseQuery, BufferedSource) -> R, val singleItemParser: (BufferedSource) -> Any? = null)

IGDB endpoints

IgdbHttpEngine

interface IgdbHttpEngine<H : IgdbHttpEngineConfig>

IgdbResult

sealed interface IgdbResult<out R : Any, out E : Any>

IgdbWebhookApi

interface IgdbWebhookApi

IgdbWebhookApi allows you to manage webhooks using the IGDB Webhook API

InternalIgdbClientApi

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

annotation class InternalIgdbClientApi

API marked with this annotation is internal, and it is not intended to be used outside IgdbClient.

Functions

executeOrThrow

suspend fun <T : Any> IgdbClient.executeOrThrow(endpoint: IgdbEndpoint<T>, query: ApicalypseQuery): T

getAgeRatingContentDescriptions

suspend fun IgdbClient.getAgeRatingContentDescriptions(builder: ApicalypseQueryBuilder.() -> Unit): AgeRatingContentDescriptionResult

Age Rating Descriptors

getAgeRatings

suspend fun IgdbClient.getAgeRatings(builder: ApicalypseQueryBuilder.() -> Unit): AgeRatingResult

Age Rating according to various rating organisations

getAlternativeNames

suspend fun IgdbClient.getAlternativeNames(builder: ApicalypseQueryBuilder.() -> Unit): AlternativeNameResult

Alternative and international game titles

getArtworks

suspend fun IgdbClient.getArtworks(builder: ApicalypseQueryBuilder.() -> Unit): ArtworkResult

Official artworks (resolution and aspect ratio may vary)

getCharacterMugShots

suspend fun IgdbClient.getCharacterMugShots(builder: ApicalypseQueryBuilder.() -> Unit): CharacterMugShotResult

Images depicting game characters

getCharacters

suspend fun IgdbClient.getCharacters(builder: ApicalypseQueryBuilder.() -> Unit): CharacterResult

Video game characters

getCollectionMemberships

suspend fun IgdbClient.getCollectionMemberships(builder: ApicalypseQueryBuilder.() -> Unit): CollectionMembershipResult

Collection memberships

getCollectionMembershipTypes

suspend fun IgdbClient.getCollectionMembershipTypes(builder: ApicalypseQueryBuilder.() -> Unit): CollectionMembershipTypeResult

Collection membership types

getCollectionRelations

suspend fun IgdbClient.getCollectionRelations(builder: ApicalypseQueryBuilder.() -> Unit): CollectionRelationResult

Describes Relationship between Collections

getCollectionRelationTypes

suspend fun IgdbClient.getCollectionRelationTypes(builder: ApicalypseQueryBuilder.() -> Unit): CollectionRelationTypeResult

Collection Relation types

getCollections

suspend fun IgdbClient.getCollections(builder: ApicalypseQueryBuilder.() -> Unit): CollectionResult

Collection, AKA Series

getCollectionTypes

suspend fun IgdbClient.getCollectionTypes(builder: ApicalypseQueryBuilder.() -> Unit): CollectionTypeResult

Collection types

getCompanies

suspend fun IgdbClient.getCompanies(builder: ApicalypseQueryBuilder.() -> Unit): CompanyResult

Video game companies. Both publishers & developers

getCompanyLogos

suspend fun IgdbClient.getCompanyLogos(builder: ApicalypseQueryBuilder.() -> Unit): CompanyLogoResult

The logos of developers and publishers

getCompanyWebsites

suspend fun IgdbClient.getCompanyWebsites(builder: ApicalypseQueryBuilder.() -> Unit): CompanyWebsiteResult

Company Website

getCovers

suspend fun IgdbClient.getCovers(builder: ApicalypseQueryBuilder.() -> Unit): CoverResult

The cover art of games

getDump

suspend fun IgdbDumpApi.getDump(endpoint: IgdbEndpoint<*>): IgdbResult<IgdbDump, IgdbHttpErrorResponse>

Returns S3 download link for the CSV dump of endpoint

getEventLogos

suspend fun IgdbClient.getEventLogos(builder: ApicalypseQueryBuilder.() -> Unit): EventLogoResult

The logos of gaming events

getEventNetworks

suspend fun IgdbClient.getEventNetworks(builder: ApicalypseQueryBuilder.() -> Unit): EventNetworkResult

Urls related to the gaming event

getEvents

suspend fun IgdbClient.getEvents(builder: ApicalypseQueryBuilder.() -> Unit): EventResult

Gaming events

getExternalGames

suspend fun IgdbClient.getExternalGames(builder: ApicalypseQueryBuilder.() -> Unit): ExternalGameResult

Game IDs on other services

getFranchises

suspend fun IgdbClient.getFranchises(builder: ApicalypseQueryBuilder.() -> Unit): FranchiseResult

A list of video game franchises such as Star Wars.

getGameEngineLogos

suspend fun IgdbClient.getGameEngineLogos(builder: ApicalypseQueryBuilder.() -> Unit): GameEngineLogoResult

The logos of game engines

getGameEngines

suspend fun IgdbClient.getGameEngines(builder: ApicalypseQueryBuilder.() -> Unit): GameEngineResult

Video game engines such as unreal engine.

getGameLocalizations

suspend fun IgdbClient.getGameLocalizations(builder: ApicalypseQueryBuilder.() -> Unit): GameLocalizationResult

Game localization for a game

getGameModes

suspend fun IgdbClient.getGameModes(builder: ApicalypseQueryBuilder.() -> Unit): GameModeResult

Single player, Multiplayer etc

getGames

suspend fun IgdbClient.getGames(builder: ApicalypseQueryBuilder.() -> Unit): GameResult

Video Games!

getGameVersionFeatures

suspend fun IgdbClient.getGameVersionFeatures(builder: ApicalypseQueryBuilder.() -> Unit): GameVersionFeatureResult

Features and descriptions of what makes each version/edition different from the main game

getGameVersionFeatureValues

suspend fun IgdbClient.getGameVersionFeatureValues(builder: ApicalypseQueryBuilder.() -> Unit): GameVersionFeatureValueResult

The bool/text value of the feature

getGameVersions

suspend fun IgdbClient.getGameVersions(builder: ApicalypseQueryBuilder.() -> Unit): GameVersionResult

Details about game editions and versions

getGameVideos

suspend fun IgdbClient.getGameVideos(builder: ApicalypseQueryBuilder.() -> Unit): GameVideoResult

A video associated with a game

getGenres

suspend fun IgdbClient.getGenres(builder: ApicalypseQueryBuilder.() -> Unit): GenreResult

Genres of video game

getInvolvedCompanies

suspend fun IgdbClient.getInvolvedCompanies(builder: ApicalypseQueryBuilder.() -> Unit): InvolvedCompanyResult

Involved Company

getKeywords

suspend fun IgdbClient.getKeywords(builder: ApicalypseQueryBuilder.() -> Unit): KeywordResult

Keywords are words or phrases that get tagged to a game such as “world war 2” or “steampunk”

getLanguages

suspend fun IgdbClient.getLanguages(builder: ApicalypseQueryBuilder.() -> Unit): LanguageResult

Languages that are used in the Language Support endpoint

getLanguageSupports

suspend fun IgdbClient.getLanguageSupports(builder: ApicalypseQueryBuilder.() -> Unit): LanguageSupportResult

Games can be played with different languages for voice acting, subtitles, or the interface language.

getLanguageSupportTypes

suspend fun IgdbClient.getLanguageSupportTypes(builder: ApicalypseQueryBuilder.() -> Unit): LanguageSupportTypeResult

Language Support Types contains the identifiers for the support types that Language Support uses.

getMultiplayerModes

suspend fun IgdbClient.getMultiplayerModes(builder: ApicalypseQueryBuilder.() -> Unit): MultiplayerModeResult

Data about the supported multiplayer types

getNetworkTypes

suspend fun IgdbClient.getNetworkTypes(builder: ApicalypseQueryBuilder.() -> Unit): NetworkTypeResult

Social networks related to the gaming event

getPlatformFamilies

suspend fun IgdbClient.getPlatformFamilies(builder: ApicalypseQueryBuilder.() -> Unit): PlatformFamilyResult

A collection of closely related platforms

getPlatformLogos

suspend fun IgdbClient.getPlatformLogos(builder: ApicalypseQueryBuilder.() -> Unit): PlatformLogoResult

Logo for a platform

getPlatforms

suspend fun IgdbClient.getPlatforms(builder: ApicalypseQueryBuilder.() -> Unit): PlatformResult

The hardware used to run the game or game delivery network

getPlatformVersionCompanies

suspend fun IgdbClient.getPlatformVersionCompanies(builder: ApicalypseQueryBuilder.() -> Unit): PlatformVersionCompanyResult

A platform developer

getPlatformVersionReleaseDates

suspend fun IgdbClient.getPlatformVersionReleaseDates(builder: ApicalypseQueryBuilder.() -> Unit): PlatformVersionReleaseDateResult

A handy endpoint that extends platform release dates. Used to dig deeper into release dates, platforms and versions

getPlatformVersions

suspend fun IgdbClient.getPlatformVersions(builder: ApicalypseQueryBuilder.() -> Unit): PlatformVersionResult

Platform Version

getPlatformWebsites

suspend fun IgdbClient.getPlatformWebsites(builder: ApicalypseQueryBuilder.() -> Unit): PlatformWebsiteResult

The main website for the platform

getPlayerPerspectives

suspend fun IgdbClient.getPlayerPerspectives(builder: ApicalypseQueryBuilder.() -> Unit): PlayerPerspectiveResult

Player perspectives describe the view/perspective of the player in a video game

getPopularityPrimitives

suspend fun IgdbClient.getPopularityPrimitives(builder: ApicalypseQueryBuilder.() -> Unit): PopularityPrimitiveResult

Popularity Primitives, this endpoint lists available primitives with their source and popularity type

getPopularityTypes

suspend fun IgdbClient.getPopularityTypes(builder: ApicalypseQueryBuilder.() -> Unit): PopularityTypeResult

This describes what type of popularity primitive or popularity indicator the popularity value is

getRegions

suspend fun IgdbClient.getRegions(builder: ApicalypseQueryBuilder.() -> Unit): RegionResult

Region for game localization

getReleaseDates

suspend fun IgdbClient.getReleaseDates(builder: ApicalypseQueryBuilder.() -> Unit): ReleaseDateResult

A handy endpoint that extends game release dates. Used to dig deeper into release dates, platforms and versions

getReleaseDateStatuses

suspend fun IgdbClient.getReleaseDateStatuses(builder: ApicalypseQueryBuilder.() -> Unit): ReleaseDateStatusResult

An endpoint to provide definition of all the current release date statuses

getScreenshots

suspend fun IgdbClient.getScreenshots(builder: ApicalypseQueryBuilder.() -> Unit): ScreenshotResult

Screenshots of games

getThemes

suspend fun IgdbClient.getThemes(builder: ApicalypseQueryBuilder.() -> Unit): ThemeResult

Video game themes

getWebsites

suspend fun IgdbClient.getWebsites(builder: ApicalypseQueryBuilder.() -> Unit): WebsiteResult

A website url, usually associated with a game

IgdbClient

fun <C : IgdbHttpEngineConfig> IgdbClient(engine: IgdbHttpEngine<C>, block: IgdbClientConfigBlock<C>.() -> Unit): IgdbClient

Creates a IgdbClient with the specified block configuration.

multiquery

suspend fun IgdbClient.multiquery(builder: ApicalypseMultiQueryBuilder.() -> Unit): List<UnpackedMultiQueryResult<*>>

Allows you to execute multiple queries at once

suspend fun IgdbClient.search(builder: ApicalypseQueryBuilder.() -> Unit): SearchResult