uk.co.thomasc.steamkit.steam3.webapi

Class WebAPI

java.lang.Object

uk.co.thomasc.steamkit.steam3.webapi.WebAPI

public final class WebAPI
extends Object

Utility class for interacting with the Steam Web API.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	API_ROOT
(package private) String	apiKey
(package private) String	iface

Constructor Summary

Constructors

Constructor and Description
WebAPI(String iface, String apiKey)

Method Summary

Methods

Modifier and Type	Method and Description
KeyValue	authenticateUser(String steamid, String sessionKey, String encryptedLoginKey, String method)
KeyValue	call(String func)
KeyValue	call(String func, int version)
KeyValue	call(String func, int version, Map<String,String> args)
KeyValue	call(String func, int version, Map<String,String> args, String method)
KeyValue	call(String func, int version, Map<String,String> args, String method, boolean secure) Manually calls the specified Web API function with the provided details.
private KeyValue	tryInvokeMember(String functionName, Map<String,String> apiArgs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iface

String iface

apiKey

String apiKey

API_ROOT

final String API_ROOT

See Also:

Constant Field Values

Constructor Detail

WebAPI

public WebAPI(String iface,
      String apiKey)

Method Detail

call

public KeyValue call(String func,
            int version,
            Map<String,String> args,
            String method,
            boolean secure)
              throws IOException

Manually calls the specified Web API function with the provided details.

Parameters:

func - The function name to call.

version - The version of the function to call.

args - A dictionary of string key value pairs representing arguments to be passed to the API.

method - The http request method. Either "POST" or "GET".

secure - if set to true this method will be called through the secure API.

Returns:

A KeyValue object representing the results of the Web API call.

Throws:

IOException - A network error occurred when performing the request.

call

public KeyValue call(String func,
            int version,
            Map<String,String> args,
            String method)
              throws IOException

Throws:

IOException

call

public KeyValue call(String func,
            int version,
            Map<String,String> args)
              throws IOException

Throws:

IOException

call

public KeyValue call(String func,
            int version)
              throws IOException

Throws:

IOException

call

public KeyValue call(String func)
              throws IOException

Throws:

IOException

authenticateUser

public KeyValue authenticateUser(String steamid,
                        String sessionKey,
                        String encryptedLoginKey,
                        String method)

tryInvokeMember

private KeyValue tryInvokeMember(String functionName,
                       Map<String,String> apiArgs)