igdbclient-core/ru.pixnews.igdbclient/IgdbClient

IgdbClient

interface IgdbClient

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

Properties

Link copied to clipboard
abstract val webhookApi: IgdbWebhookApi

Functions

Link copied to clipboard
abstract suspend fun <T : Any> execute(endpoint: IgdbEndpoint<T>, query: ApicalypseQuery): IgdbResult<T, IgdbHttpErrorResponse>

General method for making requests to the igdb server.

Link copied to clipboard
suspend fun <T : Any> IgdbClient.executeOrThrow(endpoint: IgdbEndpoint<T>, query: ApicalypseQuery): T
Link copied to clipboard
suspend fun IgdbClient.getAgeRatingContentDescriptions(builder: ApicalypseQueryBuilder.() -> Unit): AgeRatingContentDescriptionResult

Age Rating Descriptors

Link copied to clipboard
suspend fun IgdbClient.getAgeRatings(builder: ApicalypseQueryBuilder.() -> Unit): AgeRatingResult

Age Rating according to various rating organisations

Link copied to clipboard
suspend fun IgdbClient.getAlternativeNames(builder: ApicalypseQueryBuilder.() -> Unit): AlternativeNameResult

Alternative and international game titles

Link copied to clipboard
suspend fun IgdbClient.getArtworks(builder: ApicalypseQueryBuilder.() -> Unit): ArtworkResult

Official artworks (resolution and aspect ratio may vary)

Link copied to clipboard
suspend fun IgdbClient.getCharacterMugShots(builder: ApicalypseQueryBuilder.() -> Unit): CharacterMugShotResult

Images depicting game characters

Link copied to clipboard
suspend fun IgdbClient.getCharacters(builder: ApicalypseQueryBuilder.() -> Unit): CharacterResult

Video game characters

Link copied to clipboard
suspend fun IgdbClient.getCollectionMemberships(builder: ApicalypseQueryBuilder.() -> Unit): CollectionMembershipResult

Collection memberships

Link copied to clipboard
suspend fun IgdbClient.getCollectionMembershipTypes(builder: ApicalypseQueryBuilder.() -> Unit): CollectionMembershipTypeResult

Collection membership types

Link copied to clipboard
suspend fun IgdbClient.getCollectionRelations(builder: ApicalypseQueryBuilder.() -> Unit): CollectionRelationResult

Describes Relationship between Collections

Link copied to clipboard
suspend fun IgdbClient.getCollectionRelationTypes(builder: ApicalypseQueryBuilder.() -> Unit): CollectionRelationTypeResult

Collection Relation types

Link copied to clipboard
suspend fun IgdbClient.getCollections(builder: ApicalypseQueryBuilder.() -> Unit): CollectionResult

Collection, AKA Series

Link copied to clipboard
suspend fun IgdbClient.getCollectionTypes(builder: ApicalypseQueryBuilder.() -> Unit): CollectionTypeResult

Collection types

Link copied to clipboard
suspend fun IgdbClient.getCompanies(builder: ApicalypseQueryBuilder.() -> Unit): CompanyResult

Video game companies. Both publishers & developers

Link copied to clipboard
suspend fun IgdbClient.getCompanyLogos(builder: ApicalypseQueryBuilder.() -> Unit): CompanyLogoResult

The logos of developers and publishers

Link copied to clipboard
suspend fun IgdbClient.getCompanyWebsites(builder: ApicalypseQueryBuilder.() -> Unit): CompanyWebsiteResult

Company Website

Link copied to clipboard
suspend fun IgdbClient.getCovers(builder: ApicalypseQueryBuilder.() -> Unit): CoverResult

The cover art of games

Link copied to clipboard
suspend fun IgdbClient.getEventLogos(builder: ApicalypseQueryBuilder.() -> Unit): EventLogoResult

The logos of gaming events

Link copied to clipboard
suspend fun IgdbClient.getEventNetworks(builder: ApicalypseQueryBuilder.() -> Unit): EventNetworkResult

Urls related to the gaming event

Link copied to clipboard
suspend fun IgdbClient.getEvents(builder: ApicalypseQueryBuilder.() -> Unit): EventResult

Gaming events

Link copied to clipboard
suspend fun IgdbClient.getExternalGames(builder: ApicalypseQueryBuilder.() -> Unit): ExternalGameResult

Game IDs on other services

Link copied to clipboard
suspend fun IgdbClient.getFranchises(builder: ApicalypseQueryBuilder.() -> Unit): FranchiseResult

A list of video game franchises such as Star Wars.

Link copied to clipboard
suspend fun IgdbClient.getGameEngineLogos(builder: ApicalypseQueryBuilder.() -> Unit): GameEngineLogoResult

The logos of game engines

Link copied to clipboard
suspend fun IgdbClient.getGameEngines(builder: ApicalypseQueryBuilder.() -> Unit): GameEngineResult

Video game engines such as unreal engine.

Link copied to clipboard
suspend fun IgdbClient.getGameLocalizations(builder: ApicalypseQueryBuilder.() -> Unit): GameLocalizationResult

Game localization for a game

Link copied to clipboard
suspend fun IgdbClient.getGameModes(builder: ApicalypseQueryBuilder.() -> Unit): GameModeResult

Single player, Multiplayer etc

Link copied to clipboard
suspend fun IgdbClient.getGames(builder: ApicalypseQueryBuilder.() -> Unit): GameResult

Video Games!

Link copied to clipboard
suspend fun IgdbClient.getGameVersionFeatures(builder: ApicalypseQueryBuilder.() -> Unit): GameVersionFeatureResult

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

Link copied to clipboard
suspend fun IgdbClient.getGameVersionFeatureValues(builder: ApicalypseQueryBuilder.() -> Unit): GameVersionFeatureValueResult

The bool/text value of the feature

Link copied to clipboard
suspend fun IgdbClient.getGameVersions(builder: ApicalypseQueryBuilder.() -> Unit): GameVersionResult

Details about game editions and versions

Link copied to clipboard
suspend fun IgdbClient.getGameVideos(builder: ApicalypseQueryBuilder.() -> Unit): GameVideoResult

A video associated with a game

Link copied to clipboard
suspend fun IgdbClient.getGenres(builder: ApicalypseQueryBuilder.() -> Unit): GenreResult

Genres of video game

Link copied to clipboard
suspend fun IgdbClient.getInvolvedCompanies(builder: ApicalypseQueryBuilder.() -> Unit): InvolvedCompanyResult

Involved Company

Link copied to clipboard
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”

Link copied to clipboard
suspend fun IgdbClient.getLanguages(builder: ApicalypseQueryBuilder.() -> Unit): LanguageResult

Languages that are used in the Language Support endpoint

Link copied to clipboard
suspend fun IgdbClient.getLanguageSupports(builder: ApicalypseQueryBuilder.() -> Unit): LanguageSupportResult

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

Link copied to clipboard
suspend fun IgdbClient.getLanguageSupportTypes(builder: ApicalypseQueryBuilder.() -> Unit): LanguageSupportTypeResult

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

Link copied to clipboard
suspend fun IgdbClient.getMultiplayerModes(builder: ApicalypseQueryBuilder.() -> Unit): MultiplayerModeResult

Data about the supported multiplayer types

Link copied to clipboard
suspend fun IgdbClient.getNetworkTypes(builder: ApicalypseQueryBuilder.() -> Unit): NetworkTypeResult

Social networks related to the gaming event

Link copied to clipboard
suspend fun IgdbClient.getPlatformFamilies(builder: ApicalypseQueryBuilder.() -> Unit): PlatformFamilyResult

A collection of closely related platforms

Link copied to clipboard
suspend fun IgdbClient.getPlatformLogos(builder: ApicalypseQueryBuilder.() -> Unit): PlatformLogoResult

Logo for a platform

Link copied to clipboard
suspend fun IgdbClient.getPlatforms(builder: ApicalypseQueryBuilder.() -> Unit): PlatformResult

The hardware used to run the game or game delivery network

Link copied to clipboard
suspend fun IgdbClient.getPlatformVersionCompanies(builder: ApicalypseQueryBuilder.() -> Unit): PlatformVersionCompanyResult

A platform developer

Link copied to clipboard
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

Link copied to clipboard
suspend fun IgdbClient.getPlatformVersions(builder: ApicalypseQueryBuilder.() -> Unit): PlatformVersionResult

Platform Version

Link copied to clipboard
suspend fun IgdbClient.getPlatformWebsites(builder: ApicalypseQueryBuilder.() -> Unit): PlatformWebsiteResult

The main website for the platform

Link copied to clipboard
suspend fun IgdbClient.getPlayerPerspectives(builder: ApicalypseQueryBuilder.() -> Unit): PlayerPerspectiveResult

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

Link copied to clipboard
suspend fun IgdbClient.getRegions(builder: ApicalypseQueryBuilder.() -> Unit): RegionResult

Region for game localization

Link copied to clipboard
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

Link copied to clipboard
suspend fun IgdbClient.getReleaseDateStatuses(builder: ApicalypseQueryBuilder.() -> Unit): ReleaseDateStatusResult

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

Link copied to clipboard
suspend fun IgdbClient.getScreenshots(builder: ApicalypseQueryBuilder.() -> Unit): ScreenshotResult

Screenshots of games

Link copied to clipboard
suspend fun IgdbClient.getThemes(builder: ApicalypseQueryBuilder.() -> Unit): ThemeResult

Video game themes

Link copied to clipboard
suspend fun IgdbClient.getWebsites(builder: ApicalypseQueryBuilder.() -> Unit): WebsiteResult

A website url, usually associated with a game

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

Allows you to execute multiple queries at once

Link copied to clipboard
suspend fun IgdbClient.search(builder: ApicalypseQueryBuilder.() -> Unit): SearchResult

Search