ch.rasc.darksky

Class DsClient

java.lang.Object

ch.rasc.darksky.DsClient

public class DsClient
extends Object

Constructor Summary

Constructors

Constructor and Description
DsClient(String apiKey)
DsClient(String apiKey, JsonConverter jsonConverter)
DsClient(String apiKey, JsonConverter jsonConverter, okhttp3.OkHttpClient httpClient)
DsClient(String apiKey, okhttp3.OkHttpClient httpClient)

Method Summary

Modifier and Type	Method and Description
Integer	apiCalls() The number of API calls made for today.
String	responseTime() The server-side response time of the last request.
DsResponse	sendForecastRequest(DsForecastRequest request) Sends a Forecast Request to darksky.net.
DsResponse	sendTimeMachineRequest(DsTimeMachineRequest request) Sends a Time Machine Request to darksky.net A Time Machine Request returns the observed (in the past) or forecasted (in the future) hour-by-hour and daily weather conditions for a particular date.

Methods inherited from class java.lang.Object

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

Constructor Detail

DsClient

public DsClient(String apiKey)

DsClient

public DsClient(String apiKey,
                okhttp3.OkHttpClient httpClient)

DsClient

public DsClient(String apiKey,
                JsonConverter jsonConverter)

DsClient

public DsClient(String apiKey,
                JsonConverter jsonConverter,
                okhttp3.OkHttpClient httpClient)

Method Detail

sendForecastRequest

@Nullable
public DsResponse sendForecastRequest(DsForecastRequest request)
                                         throws IOException

Sends a Forecast Request to darksky.net.

Parameters:

Request - object

Returns:

The darksky response

Throws:

IOException

sendTimeMachineRequest

@Nullable
public DsResponse sendTimeMachineRequest(DsTimeMachineRequest request)
                                            throws IOException

Sends a Time Machine Request to darksky.net A Time Machine Request returns the observed (in the past) or forecasted (in the future) hour-by-hour and daily weather conditions for a particular date. A Time Machine request is identical in structure to a Forecast Request, except:

The DsResponse.currently() data point will refer to the time provided, rather than the current time. The DsResponse.minutely() data block will be omitted, unless you are requesting a time within an hour of the present. The DsResponse.hourly() data block will contain data points starting at midnight (local time) of the day requested, and continuing until midnight (local time) of the following day. The DsResponse.daily() data block will contain a single data point referring to the requested date. The DsResponse.alerts() data block will be omitted.

Parameters:

Request - object

Returns:

The darksky response

Throws:

IOException

apiCalls

public Integer apiCalls()

The number of API calls made for today. Value is only set after a request.

responseTime

public String responseTime()

The server-side response time of the last request. Only set after a request.