WPAddress Class Reference

#import <WPAddress.h>

Inheritance diagram for WPAddress:

Instance Methods
(instancetype)	- initWithZip:
(instancetype)	- initWithAddress1:address2:city:state:zip:
(instancetype)	- initWithAddress1:address2:city:region:postcode:country:
(NSDictionary *)	- toDict

Properties
NSString *	address1
NSString *	address2
NSString *	city
NSString *	country
NSString *	postcode
NSString *	region
NSString *	state
NSString *	zip

Detailed Description

An instance of this class represents a physical address.

Method Documentation

initWithAddress1:address2:city:region:postcode:country:()

- (instancetype) initWithAddress1:		(NSString *)	address1
address2:		(NSString *)	address2
city:		(NSString *)	city
region:		(NSString *)	region
postcode:		(NSString *)	postcode
country:		(NSString *)	country

Initializes a non-US Address.

Parameters

address1	The first line of the street address.
address2	The second line of the street address.
city	The city.
region	The region. Only for non-US addresses when available.
postcode	The postcode. Only for non-US addresses when available.
country	The 2-letters ISO-3166-1 country code.

Returns

The address.

initWithAddress1:address2:city:state:zip:()

- (instancetype) initWithAddress1:		(NSString *)	address1
address2:		(NSString *)	address2
city:		(NSString *)	city
state:		(NSString *)	state
zip:		(NSString *)	zip

Initializes a US Address.

Parameters

address1	The first line of the street address.
address2	The second line of the street address.
city	The city.
state	The 2-letters US state code.
zip	The US zip or zip-plus code.

Returns

The address.

initWithZip:()

- (instancetype) initWithZip:

(NSString *)

zip

Initializes a US Address with just a zip.

Parameters

zip	The US zip or zip-plus code.

Returns

The address.

Property Documentation

address1

- (NSString*) address1

readnonatomicstrong

The first line of the street address.

address2

- (NSString*) address2

readnonatomicstrong

The second line of the street address.

city

- (NSString*) city

readnonatomicstrong

The city.

country

- (NSString*) country

readnonatomicstrong

The 2-letters ISO-3166-1 country code.

postcode

- (NSString*) postcode

readnonatomicstrong

The postcode. Only for non-US addresses when available.

region

- (NSString*) region

readnonatomicstrong

The region. Only for non-US addresses when available.

state

- (NSString*) state

readnonatomicstrong

The 2-letters US state code. Only for US addresses.

zip

- (NSString*) zip

readnonatomicstrong

The US zip or zip-plus code. Only for US addresses.

---

The documentation for this class was generated from the following file:

• WPAddress.h