summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLOasisAddress.html
blob: fbc65c018e287e1b6924acdfc375fb475ef5b3bd (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<h1>SDLOasisAddress Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:">-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:</a></li>
  <li><a href="#section--initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:">-initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:</a></li>
  <li><a href="#section-countryName">countryName</a></li>
  <li><a href="#section-countryCode">countryCode</a></li>
  <li><a href="#section-postalCode">postalCode</a></li>
  <li><a href="#section-administrativeArea">administrativeArea</a></li>
  <li><a href="#section-subAdministrativeArea">subAdministrativeArea</a></li>
  <li><a href="#section-locality">locality</a></li>
  <li><a href="#section-subLocality">subLocality</a></li>
  <li><a href="#section-thoroughfare">thoroughfare</a></li>
  <li><a href="#section-subThoroughfare">subThoroughfare</a></li>
</ul>

<h3>Overview</h3>

<p>Struct used in SendLocation describing an address</p>


<section class="section task-group-section">
  <h3 id="section--initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:">
      -initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:
  </h3>
  
  <p>Convenience init to describe an oasis address</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithSubThoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subThoroughfare</span>
               <span class="nf">thoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">thoroughfare</span>
                   <span class="nf">locality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locality</span>
         <span class="nf">administrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">administrativeArea</span>
                 <span class="nf">postalCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">postalCode</span>
                <span class="nf">countryCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryCode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">subThoroughfare</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">thoroughfare</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">locality</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">administrativeArea</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">postalCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">countryCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>subThoroughfare</dt>
      <dd><p>Portion of thoroughfare (e.g. house number)</p></dd>
      <dt>thoroughfare</dt>
      <dd><p>Hypernym for street, road etc</p></dd>
      <dt>locality</dt>
      <dd><p>Hypernym for city/village</p></dd>
      <dt>administrativeArea</dt>
      <dd><p>Portion of country (e.g. state)</p></dd>
      <dt>postalCode</dt>
      <dd><p>PostalCode of location (PLZ, ZIP, PIN, CAP etc.)</p></dd>
      <dt>countryCode</dt>
      <dd><p>CountryCode of the country(ISO 3166-2)</p></dd>
  </dl>
  
  <h3 id="section--initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:">
      -initWithSubThoroughfare:thoroughfare:locality:administrativeArea:postalCode:countryCode:countryName:subAdministrativeArea:subLocality:
  </h3>
  
  <p>Convenience init to describe an oasis address with all parameters</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithSubThoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subThoroughfare</span>
               <span class="nf">thoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">thoroughfare</span>
                   <span class="nf">locality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locality</span>
         <span class="nf">administrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">administrativeArea</span>
                 <span class="nf">postalCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">postalCode</span>
                <span class="nf">countryCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryCode</span>
                <span class="nf">countryName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryName</span>
      <span class="nf">subAdministrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subAdministrativeArea</span>
                <span class="nf">subLocality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subLocality</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">subThoroughfare</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">thoroughfare</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">locality</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">administrativeArea</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">postalCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">countryCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">countryName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">subAdministrativeArea</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">subLocality</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>subThoroughfare</dt>
      <dd><p>Portion of thoroughfare (e.g. house number)</p></dd>
      <dt>thoroughfare</dt>
      <dd><p>Hypernym for street, road etc</p></dd>
      <dt>locality</dt>
      <dd><p>Hypernym for city/village</p></dd>
      <dt>administrativeArea</dt>
      <dd><p>Portion of country (e.g. state)</p></dd>
      <dt>postalCode</dt>
      <dd><p>PostalCode of location (PLZ, ZIP, PIN, CAP etc.)</p></dd>
      <dt>countryCode</dt>
      <dd><p>CountryCode of the country(ISO 3166-2)</p></dd>
      <dt>subAdministrativeArea</dt>
      <dd><p>Portion of administrativeArea (e.g. county)</p></dd>
      <dt>subLocality</dt>
      <dd><p>Hypernym for district</p></dd>
  </dl>
  
  <h3 id="section-countryName">
      countryName
  </h3>
  
  <p>Name of the country (localized)</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">countryName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">countryName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-countryCode">
      countryCode
  </h3>
  
  <p>countryCode of the country(ISO 3166-2)</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">countryCode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">countryCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-postalCode">
      postalCode
  </h3>
  
  <p>postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">postalCode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">postalCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-administrativeArea">
      administrativeArea
  </h3>
  
  <p>Portion of country (e.g. state)</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">administrativeArea</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">administrativeArea</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-subAdministrativeArea">
      subAdministrativeArea
  </h3>
  
  <p>Portion of administrativeArea (e.g. county)</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">subAdministrativeArea</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subAdministrativeArea</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-locality">
      locality
  </h3>
  
  <p>Hypernym for city/village</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">locality</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">locality</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-subLocality">
      subLocality
  </h3>
  
  <p>Hypernym for district</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">subLocality</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subLocality</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-thoroughfare">
      thoroughfare
  </h3>
  
  <p>Hypernym for street, road etc.</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">thoroughfare</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">thoroughfare</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-subThoroughfare">
      subThoroughfare
  </h3>
  
  <p>Portion of thoroughfare (e.g. house number)</p>

<p>Optional, max length = 200</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">subThoroughfare</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subThoroughfare</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>