summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLWeatherAlert.h
blob: 29a7824e7da73f413214bea0f95a56384a246e04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
//
//  SDLWeatherAlert.h
//  SmartDeviceLink
//
//  Created by Nicole on 2/6/19.
//  Copyright © 2019 smartdevicelink. All rights reserved.
//

#import "SDLRPCRequest.h"
#import "SDLDateTime.h"

NS_ASSUME_NONNULL_BEGIN

@interface SDLWeatherAlert : SDLRPCStruct

/**
 *  Convenience init for all parameters
 *
 *  @param title        The title of the alert
 *  @param summary      A summary for the alert
 *  @param expires      The date the alert expires
 *  @param regions      Regions affected
 *  @param severity     Severity
 *  @param timeIssued   The date the alert was issued
 *  @return             A SDLWeatherAlert alert
 */
- (instancetype)initWithTitle:(nullable NSString *)title summary:(nullable NSString *)summary expires:(nullable SDLDateTime *)expires regions:(nullable NSArray<NSString *> *)regions severity:(nullable NSString *)severity timeIssued:(nullable SDLDateTime *)timeIssued;

/**
 *  The title of the alert.
 *
 *  String, Optional
 */
@property (nullable, strong, nonatomic) NSString *title;

/**
 *  A summary for the alert.
 *
 *  String, Optional
 */
@property (nullable, strong, nonatomic) NSString *summary;

/**
 *  The date the alert expires.
 *
 *  SDLDateTime, Optional
 */
@property (nullable, strong, nonatomic) SDLDateTime *expires;

/**
 *  Regions affected.
 *
 *  Array of Strings, Optional, minsize="1" maxsize="99"
 */
@property (nullable, strong, nonatomic) NSArray<NSString *> *regions;

/**
 *  Severity of the weather alert.
 *
 *  String, Optional
 */
@property (nullable, strong, nonatomic) NSString *severity;

/**
 *  The date the alert was issued.
 *
 *  SDLDateTime, Optional
 */
@property (nullable, strong, nonatomic) SDLDateTime *timeIssued;

@end

NS_ASSUME_NONNULL_END