com.lukaspradel.steamapi.webapi.request.SteamWebApiServiceParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of steam-web-api Show documentation

A library to provide access to the data available from Valve's Steam API

There is a newer version: 1.9.0

package com.lukaspradel.steamapi.webapi.request;

import com.lukaspradel.steamapi.webapi.request.builders.AbstractSteamWebApiServiceRequestBuilder;

/**
 * Skeleton for Steam Web API service parameters. Web API endpoints whose names
 * end with "Service" (e.g. "IPlayerService") require a specific service
 * parameter in the form of a single JSON blob for certain parameters. If the
 * service parameter is used, ALL request parameters must be included in the
 * JSON blob. Exceptions are "key" parameter and the "format" parameter. 

 * 

 * Heirs of this class must be Jackson-annotated POJOs that are converted to
 * JSON by {@link AbstractSteamWebApiServiceRequestBuilder}.
 *
 * @see https://developer.valvesoftware.com/wiki/Steam_Web_API#Calling_Service_interfaces
 * @author lpradel
 *
 */
public abstract class SteamWebApiServiceParameter {
}