BTPostalAddress

@objcMembers
public class BTPostalAddress : NSObject, Encodable

Generic postal address

Show on GitHub

Initializer

  • Creats a postal address with all components

    Declaration

    Swift

    public init(
    recipientName: String? = nil,
    streetAddress: String? = nil,
    extendedAddress: String? = nil,
    locality: String? = nil,
    countryCodeAlpha2: String? = nil,
    postalCode: String? = nil,
    region: String? = nil
)

    Parameters

    recipientName

    Optional. Recipient name for shipping address.
    streetAddress

    Optional. Line 1 of the Address (eg. number, street, etc).
    extendedAddress

    Optional. Line 2 of the Address (eg. suite, apt #, etc.).
    locality

    Optional. City name
    countryCodeAlpha2

    Optional. 2 letter country code.
    postalCode

    Optional. Zip code or equivalent is usually required for countries that have them. For a list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
    region

    Optional. Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.
    Show on GitHub

Helper Method

  • Returns address components as a dictionary for accessing internal properties across modules

    Declaration

    Swift

    public func addressComponents() -> [String : String]
    Show on GitHub