summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLOasisAddress.h
blob: 60edbb33de6adb74cf18e96cf58e4c210a27a97a (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
74
75
76
77
78
79
80
81
82
//  SDLOasisAddress.h
//

#import "SDLRPCStruct.h"

NS_ASSUME_NONNULL_BEGIN

/**
 Struct used in SendLocation describing an address
 */
@interface SDLOasisAddress : SDLRPCStruct

- (instancetype)initWithSubThoroughfare:(nullable NSString *)subThoroughfare thoroughfare:(nullable NSString *)thoroughfare locality:(nullable NSString *)locality administrativeArea:(nullable NSString *)administrativeArea postalCode:(nullable NSString *)postalCode countryCode:(nullable NSString *)countryCode;

- (instancetype)initWithSubThoroughfare:(nullable NSString *)subThoroughfare thoroughfare:(nullable NSString *)thoroughfare locality:(nullable NSString *)locality administrativeArea:(nullable NSString *)administrativeArea postalCode:(nullable NSString *)postalCode countryCode:(nullable NSString *)countryCode countryName:(nullable NSString *)countryName subAdministrativeArea:(nullable NSString *)subAdministrativeArea subLocality:(nullable NSString *)subLocality;

/**
 * Name of the country (localized)
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *countryName;

/**
 * countryCode of the country(ISO 3166-2)
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *countryCode;

/**
 * postalCode of location (PLZ, ZIP, PIN, CAP etc.)
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *postalCode;

/**
 * Portion of country (e.g. state)
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *administrativeArea;

/**
 * Portion of administrativeArea (e.g. county)
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *subAdministrativeArea;

/**
 * Hypernym for city/village
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *locality;

/**
 * Hypernym for district
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *subLocality;

/**
 * Hypernym for street, road etc.
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *thoroughfare;

/**
 * Portion of thoroughfare (e.g. house number)
 *
 * Optional, max length = 200
 */
@property (nullable, copy, nonatomic) NSString *subThoroughfare;

@end

NS_ASSUME_NONNULL_END