nl.pvanassen.steam.store.inventory.InventoryService Maven / Gradle / Ivy

Go to download

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

A Java API to access the Steam community market through the HTTP interface. This may be against the TOS so be careful using it!

The newest version!

/**
 *
 */
package nl.pvanassen.steam.store.inventory;

import nl.pvanassen.steam.store.common.InventoryItem;

import java.util.List;

/**
 * @author Paul van Assen
 */
public interface InventoryService {
    /**
     * Retrieve all that is in the inventory of the user
     *
     * @return List of items in the inventory
     */
    List getInventory();

    /**
     * Retrieve the inventory of a user for only one app id
     *
     * @param appId Retrieve only one app id
     * @return List of items in the inventory
     */
    List getInventory(int appId);

    /**
     * Retrieve all that is in the inventory of a user
     *
     * @param username The username to get the inventory from
     * @return List of items in the inventory
     */
    List getInventory(String username);

    /**
     * Retrieve all that is in the inventory of a user and an app id
     *
     * @param username The username to get the inventory from
     * @param appId Retrieve only one app id
     * @return List of items in the inventory
     */
    List getInventory(String username, int appId);

}