GMSAddressComponent.h 1.32 KB
Newer Older
Julio Hermosa committed
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
//
//  GMSAddressComponent.h
//  Google Places SDK for iOS
//
//  Copyright 2016 Google Inc.
//
//  Usage of this SDK is subject to the Google Maps/Google Earth APIs Terms of
//  Service: https://developers.google.com/maps/terms
//

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

/**
 * Represents a component of an address, e.g., street number, postcode, city, etc.
 */
@interface GMSAddressComponent : NSObject

/**
 * Type of the address component. For a list of supported types, see
 * https://developers.google.com/places/ios-sdk/supported_types#table2. This string will be one
 * of the constants defined in GMSPlaceTypes.h.
 */
@property(nonatomic, readonly, copy)
    NSString *type __deprecated_msg("type property is deprecated in favor of types)");

/**
 * Types associated with the address component. For a list of supported types, see
 * https://developers.google.com/places/ios-sdk/supported_types#table2. This array will contain
 * one or more of the constants strings defined in GMSPlaceTypes.h.
 */
@property(nonatomic, readonly, strong) NSArray<NSString *> *types;

/** Name of the address component, e.g. "Sydney" */
@property(nonatomic, readonly, copy) NSString *name;

/** Short name of the address component, e.g. "AU" */
@property(nonatomic, readonly, copy) NSString *_Nullable shortName;

@end

NS_ASSUME_NONNULL_END