AWFAdvisory
@interface AWFAdvisory : AWFGeographicObject
An AWFAdvisory
object represents data returned by the advisories endpoint
of the Aeris Weather API.
-
Valid-time event code (VTEC) for the advisory.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *type;
Swift
var type: String? { get set }
-
Type name of the advisory.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *name;
Swift
var name: String? { get set }
-
Weather zone for the advisory.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *zone;
Swift
var zone: String? { get set }
-
Shortened and formatted version of the advisory body text.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *body;
Swift
var body: String? { get set }
-
Complete, unmodified version of the advisory body text including raw headers.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *bodyFull;
Swift
var bodyFull: String? { get set }
-
GMT date when the advisory was issued.
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSDate *issued;
Swift
var issued: Date? { get set }
-
GMT date when the advisory goes into effect.
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSDate *begins;
Swift
var begins: Date? { get set }
-
GMT date when the advisory expires.
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSDate *expires;
Swift
var expires: Date? { get set }
-
GMT date when the advisory was stored.
Declaration
Objective-C
@property (readwrite, strong, nonatomic, nullable) NSDate *added;
Swift
var added: Date? { get set }
-
A comma-delimited string of coordinates (longitude, latitude) defining the boundary for the advisory. * Typically this is only used for certain short-fuse advisories, such as tornado and severe thunderstorm warnings.
Declaration
Objective-C
@property (readwrite, copy, nonatomic, nullable) NSString *polygon;
Swift
var polygon: String? { get set }
-
A
AWFGeoPolygon
instance created from the string of coordinates found inpolygon
, if any.Declaration
Objective-C
@property (readonly, nonatomic, nullable) AWFGeoPolygon *geoPolygon;
Swift
var geoPolygon: AWFGeoPolygon? { get }
-
Returns a dictionary of
UIColor
instances mapped to their respective advisory VTEC codes. This is the standard advisory color associations used by the National Weather Service (NWS) and those used with the advisory map overlay.Declaration
Objective-C
+ (nonnull NSDictionary<NSString *, UIColor *> *)colorMappingsForTypes;
Swift
class func colorMappingsForTypes() -> [String : UIColor]
-
Returns a dictionary of advisory names mapped to their respective advisory VTEC codes.
Declaration
Objective-C
+ (nonnull NSDictionary<NSString *, NSString *> *)namesByType;
Swift
class func namesByType() -> [String : String]
-
Returns the standard color associated with the specific advisory VTEC code.
Declaration
Objective-C
+ (nullable UIColor *)colorForAdvisoryWithType:(nonnull NSString *)type;
Swift
class func colorForAdvisory(withType type: String) -> UIColor?
Parameters
type
The advisory VTEC code to return the color for
Return Value
A
UIColor
instance for the advisory type