HPDarkSky Documentation Beta

Classes

Dark​Sky​Request

A request object to use with your own networking

HPDark​Sky

Type that handles making requests and decoding the returned response into a usable format

Structures

Alert

Type holding information about weather alerts such as thunderstorms

Current​Datapoint

A datapoint that holds basic information and also the current temperature

Daily​Datapoint

A datapoint that holds information about the average daily weather conditions

Dark​Sky​Response

Type holding any information that is returned by the API

Flags

The flags object contains various metadata information related to the request

Forecast

Generic type that can hold any type of data point, e.g. hourly or daily

Hourly​Datapoint

Type holding information about hourly weather conditions, such as precipitation and temperature

Minutely​Datapoint

Type holding information about minutely precipiation

Precipitation

Type holding information about precipitation, such as snow/rain/etc.

Wind

Type holding information about the wind, such as speed, bearing and gust

Enumerations

Alert​Severity

Enum specifying the severity of a weather alert

Excludable​Fields

Enum to exclude certain fields from the weather response

Language

Enum to specify the language used in a weather response

Precipitation​Type

Enum specifying the type of precipitation

Weather​Icon

An enum providing native system icons based on the API response

Weather​Units

Enum used to specify the units used in the API response to forma the data