La libreria Javascript di IGDB è un wrapper per le API di The Internet Game Database (IGDB).
Per usare questa libreria è necessario registrare una API Key, visita IGDB API Docs per maggiori info.
Il codice sorgente è disponibile nella repository GitHub.
app.api.igdb
La libreria è accessibile da app.api.igdb object.
client_id string
Imposta il Client ID per le API (obbligatorio).
client_secret string
Imposta il Client Secret per le API (obbligatorio).
search(query app.query object) array of search results
La funzione ricerca giochi e restituisce un array di risultati di ricerca.
getGame(id integer) game
La funzione ottiene un gioco dall'ID. Restituisce un gioco oppure undefined se questo non esiste.
extraFields array of string
Campi addizionali usati per eseguire la query del gioco. Consulta la documentazione su IGDB per maggiori info.
gameClass class
Imposta una classe personalizzata per game, la classe deve estendere app.classes.api.igdb.game
request(endpoint string, body string) app.request
Crea un nuova richiesta HTTP con l'endpoint ed il body specificato. Potresti voler chiamare questa funzione nella tua implementazione custom.
refreshTokenIfNeeded()
Aggiorna l'access token se necessario. Di solito non devi chiamare questa funzione, la libreria gestisce l'access token automaticamente.
clearToken()
Cancella l'access token dallo storage locale.
// IGDB search (1.1) // https://github.com/risolvipro/collections app.api.igdb.client_id = "YOUR CLIENT ID"; app.api.igdb.client_secret = "YOUR CLIENT SECRET"; let results = app.api.igdb.search(app.query); app.result(results);
Game
app.classes.api.igdb.game
Questa classe gestisce un gioco.
constructor(data json) game
data json
I dati json restituiti dalle API di IGDB.
id integer
ID del gioco.
name string
Nome del gioco.
dataCoverURL date
URL della cover dai dati json.
coverURL(size string) string
Ottieni l'URL della copertina nella dimensione specificata. Il parametro size è opzionale, il valore predefinito è "original".
requestCover(size string) image
Richiedi la copertina nella dimensione specificata. Il parametro size è opzionale, il valore predefinito è "original". Restituisce un'immagine oppure undefined se la richiesta fallisce..
firstReleaseDate date
Prima data di rilascio del gioco.
platforms array of list item suggestions
Ottieni le piattaforme come array di suggerimenti per una lista.
genres array of list item suggestions
Ottieni i generi come array di suggerimenti per una lista.
summary string
Ottieni il riassunto.
// IGDB document (1.1)
// https://github.com/risolvipro/collections
app.api.igdb.client_id = "YOUR CLIENT ID";
app.api.igdb.client_secret = "YOUR CLIENT SECRET";
let game = app.api.igdb.getGame(app.params.id);
if(game == undefined) {
app.fail();
}
let builder = app.document.builder();
builder.setString(game.name, "title");
builder.setImage(game.requestCover(), "cover");
builder.setListItems(game.platforms, "platform");
builder.setListItems(game.genres, "genre");
builder.setDate(game.firstReleaseDate, "release-date");
builder.setString(game.summary, "summary");
app.result(builder);