com.lukaspradel.steamapi.webapi.request.GetRecentlyPlayedGamesRequest 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.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.lukaspradel.steamapi.webapi.core.SteamWebApiInterface;
import com.lukaspradel.steamapi.webapi.core.SteamWebApiInterfaceMethod;
import com.lukaspradel.steamapi.webapi.core.SteamWebApiVersion;
import com.lukaspradel.steamapi.webapi.request.builders.AbstractSteamWebApiServiceRequestBuilder;

/**
 * Steam Web API Request GetRecentlyPlayedGames
 *
 * @see https://developer.valvesoftware.com/wiki/Steam_Web_API#GetRecentlyPlayedGames_.28v0001.29
 * @author lpradel
 *
 */
public class GetRecentlyPlayedGamesRequest extends SteamWebApiRequest {

	private GetRecentlyPlayedGamesRequest(SteamWebApiRequestBuilder builder) {
		super(builder);
	}

	/**
	 * The service parameter instance of {@link SteamWebApiServiceParameter} for
	 * {@link GetRecentlyPlayedGamesRequest}.
	 *
	 * @author lpradel
	 *
	 */
	@JsonInclude(JsonInclude.Include.NON_NULL)
	public static class GetRecentlyPlayedGamesRequestServiceParameter extends
			SteamWebApiServiceParameter {

		private String steamId;

		private Integer count;

		@JsonProperty(GetRecentlyPlayedGamesRequestBuilder.REQUEST_PARAM_STEAM_ID)
		public String getSteamId() {
			return steamId;
		}

		@JsonProperty(GetRecentlyPlayedGamesRequestBuilder.REQUEST_PARAM_COUNT)
		public Integer getCount() {
			return count;
		}

		public void setSteamId(String steamId) {
			this.steamId = steamId;
		}

		public void setCount(Integer count) {
			this.count = count;
		}
	}

	/**
	 * Builder object to create instances of {@link SteamWebApiRequest} for
	 * request type {@link GetRecentlyPlayedGamesRequest}.
	 *
	 * @author lpradel
	 *
	 */
	public static class GetRecentlyPlayedGamesRequestBuilder extends
			AbstractSteamWebApiServiceRequestBuilder {

		private final String steamId;

		private Integer count;

		public static final String REQUEST_PARAM_STEAM_ID = "steamid";

		public static final String REQUEST_PARAM_COUNT = "count";

		public GetRecentlyPlayedGamesRequestBuilder(String steamId) {

			this.steamId = steamId;
		}

		public GetRecentlyPlayedGamesRequestBuilder count(Integer count) {

			this.count = count;
			return this;
		}

		@Override
		protected SteamWebApiInterface getInterface() {

			return SteamWebApiInterface.I_PLAYER_SERVICE;
		}

		@Override
		protected SteamWebApiInterfaceMethod getInterfaceMethod() {

			return SteamWebApiInterfaceMethod.GET_RECENTLY_PLAYED_GAMES;
		}

		@Override
		protected SteamWebApiVersion getVersion() {

			return SteamWebApiVersion.VERSION_ONE;
		}

		@Override
		public GetRecentlyPlayedGamesRequest buildRequest() {

			GetRecentlyPlayedGamesRequestServiceParameter serviceParameter = new GetRecentlyPlayedGamesRequestServiceParameter();

			serviceParameter.setSteamId(steamId);

			if (count != null) {
				serviceParameter.setCount(count);
			}

			addServiceParameter(serviceParameter);

			return new GetRecentlyPlayedGamesRequest(this);
		}
	}
}