com.thebluealliance.api.v3.requests

Class DataRequest

java.lang.Object

com.thebluealliance.api.v3.requests.DataRequest

public class DataRequest
extends java.lang.Object

Used to issue a direct request for data to The Blue Alliance via a URL

Constructor Summary

Constructors

Constructor and Description
DataRequest(java.lang.String authKey) Constructs an object to make a data request

Method Summary

Modifier and Type	Method and Description
APIResponse	getDataTBA(java.lang.String urlDirectory) Retrieves data from TBA API using a URL, without a If-Modified-Since header
APIResponse	getDataTBA(java.lang.String urlDirectory, java.lang.String ifModifiedSince) Retrieves data from TBA API using a URL and a If-Modified-Since header

Methods inherited from class java.lang.Object

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

Constructor Detail

DataRequest

public DataRequest(java.lang.String authKey)

Constructs an object to make a data request

Parameters:

authKey - TBA API com.thebluealliance.api.v3 authentication key

Method Detail

getDataTBA

public APIResponse getDataTBA(java.lang.String urlDirectory)
                       throws java.io.IOException

Retrieves data from TBA API using a URL, without a If-Modified-Since header

Parameters:

urlDirectory - URL subdirectory for the query (e.g. /team/frc25)

Returns:

An APIResponse object with the API's response

Throws:

java.io.IOException

getDataTBA

public APIResponse getDataTBA(java.lang.String urlDirectory,
                              java.lang.String ifModifiedSince)
                       throws java.io.IOException

Retrieves data from TBA API using a URL and a If-Modified-Since header

Parameters:

urlDirectory - URL subdirectory for the query (e.g. /team/frc25)

ifModifiedSince - Value of the Last-Modified header in the most recently cached response by the client.

Returns:

An APIResponse object with the API's response

Throws:

java.io.IOException