net.namibsun.hktipp.api

Class ApiConnection

net.namibsun.hktipp.api.ApiConnection

public class ApiConnection

Class that allows interaction with the hk-tippspiel API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiConnection.Companion Contains static methods of the class

Field Summary

Fields

Modifier and Type	Field and Description
static ApiConnection.Companion	Companion Contains static methods of the class

Constructor Summary

Constructors

Constructor and Description
ApiConnection(java.lang.String serverUrl, java.lang.String apiKey, User user, int expiration) Class that allows interaction with the hk-tippspiel API

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	get(java.lang.String endpoint, java.util.Map<java.lang.String,? extends java.lang.Object> params) Performs an authenticated GET request to the API
int	getExpiration() :
User	getUser()
boolean	isAuthorized() Checks if the ApiConnection is authorized or not
void	logout(BaseActivity context) Logs out by deleting the API key
org.json.JSONObject	put(java.lang.String endpoint, java.util.Map<java.lang.String,? extends java.lang.Object> params) Performs an authenticated PUT request to the API
void	store(BaseActivity context) Stores the API Connection info in the shared preferences

Field Detail

Companion

public static ApiConnection.Companion Companion

Contains static methods of the class

Constructor Detail

ApiConnection

public ApiConnection(java.lang.String serverUrl,
                     java.lang.String apiKey,
                     User user,
                     int expiration)

Class that allows interaction with the hk-tippspiel API

Parameters:

serverUrl - : The server URL to use

apiKey - : The API key to use for authentication

expiration - : The expiration time of the API key

serverUrl - : The server URL to use

apiKey - : The API key to use for authentication

expiration - : The expiration time of the API key

Method Detail

isAuthorized

public boolean isAuthorized()

Checks if the ApiConnection is authorized or not

Returns:

true if the connection is authorized, false otherwise

logout

public void logout(BaseActivity context)

Logs out by deleting the API key

Parameters:

context - : If provided, deletes the API key information from the shared preferences

store

public void store(BaseActivity context)

Stores the API Connection info in the shared preferences

Parameters:

context - : The context from which to load the shared preferences

get

public org.json.JSONObject get(java.lang.String endpoint,
                               java.util.Map<java.lang.String,? extends java.lang.Object> params)

Performs an authenticated GET request to the API

Parameters:

endpoint - : The API endpoint to connect to

params - : The parameters to send

put

public org.json.JSONObject put(java.lang.String endpoint,
                               java.util.Map<java.lang.String,? extends java.lang.Object> params)

Performs an authenticated PUT request to the API

Parameters:

endpoint - : The API endpoint to connect to

params - : The parameters to send

getUser

public User getUser()

getExpiration

public int getExpiration()

:

The expiration time of the API key