edu.illinois.cs.cs125.fall2019.mp

Class WebApi

java.lang.Object

edu.illinois.cs.cs125.fall2019.mp.WebApi

public final class WebApi
extends java.lang.Object

Provides methods for contacting the server. Used starting in Checkpoint 2.

STOP! Do not modify this file. Changes will be overwritten during official grading.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	API_BASE The URL at which the server is hosted.
(package private) static java.lang.String	WEBSOCKET_BASE The URL at which the webserver socket is hosted.

Method Summary

Modifier and Type	Method and Description
static void	connectWebSocket(java.lang.String url, java.util.function.Consumer<com.google.gson.JsonObject> dataListener, java.util.function.Consumer<com.neovisionaries.ws.client.WebSocket> onCreatedListener, java.lang.Runnable connectionLostListener, java.util.function.Consumer<java.lang.Throwable> errorListener) Connects to a websocket.
static void	startRequest(android.content.Context context, java.lang.String url, int method, com.google.gson.JsonElement body, com.android.volley.Response.Listener<com.google.gson.JsonObject> listener, com.android.volley.Response.ErrorListener errorListener) Starts a network request with a JSON object as the payload.
static void	startRequest(android.content.Context context, java.lang.String url, com.android.volley.Response.Listener<com.google.gson.JsonObject> listener, com.android.volley.Response.ErrorListener errorListener) Starts an HTTP GET request.

Methods inherited from class java.lang.Object

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

Field Detail

API_BASE

static final java.lang.String API_BASE

The URL at which the server is hosted.

See Also:

Constant Field Values

WEBSOCKET_BASE

static final java.lang.String WEBSOCKET_BASE

The URL at which the webserver socket is hosted.

See Also:

Constant Field Values

Method Detail

connectWebSocket

public static void connectWebSocket(java.lang.String url,
                                    java.util.function.Consumer<com.google.gson.JsonObject> dataListener,
                                    java.util.function.Consumer<com.neovisionaries.ws.client.WebSocket> onCreatedListener,
                                    java.lang.Runnable connectionLostListener,
                                    java.util.function.Consumer<java.lang.Throwable> errorListener)

Connects to a websocket.

Parameters:

url - the websocket endpoint

dataListener - receiver for data messages

onCreatedListener - callback to run with the websocket when it is created

connectionLostListener - callback to run if the connection is lost

errorListener - callback to run if an error occurs during the initial connection

startRequest

public static void startRequest(android.content.Context context,
                                java.lang.String url,
                                int method,
                                com.google.gson.JsonElement body,
                                com.android.volley.Response.Listener<com.google.gson.JsonObject> listener,
                                com.android.volley.Response.ErrorListener errorListener)

Starts a network request with a JSON object as the payload.

Parameters:

context - an Android context

url - the URL to contact

method - the HTTP method (e.g. GET or POST)

body - the JSON object to include in the body

listener - callback to run with response data

errorListener - callback to run if an error occurs

startRequest

public static void startRequest(android.content.Context context,
                                java.lang.String url,
                                com.android.volley.Response.Listener<com.google.gson.JsonObject> listener,
                                com.android.volley.Response.ErrorListener errorListener)

Starts an HTTP GET request.

Parameters:

context - an Android context

url - the URL to contact

listener - callback to run with response data

errorListener - callback to run if an error occurs