GooglePlaces Framework Reference

GMSAutocompletePrediction

@interface GMSAutocompletePrediction : NSObject

This class represents a prediction of a full query based on a partially typed string.

  • The full description of the prediction as a NSAttributedString. E.g., “Sydney Opera House, Sydney, New South Wales, Australia”.

    Every text range that matches the user input has a kGMSAutocompleteMatchAttribute. For example, you can make every match bold using enumerateAttribute: 

       UIFont *regularFont = [UIFont systemFontOfSize:[UIFont labelFontSize]];
   UIFont *boldFont = [UIFont boldSystemFontOfSize:[UIFont labelFontSize]];
    


    NSMutableAttributedString *bolded = [prediction.attributedFullText mutableCopy];
   [bolded enumerateAttribute:kGMSAutocompleteMatchAttribute
                      inRange:NSMakeRange(0, bolded.length)
                      options:0
                   usingBlock:^(id value, NSRange range, BOOL *stop) {
                     UIFont *font = (value == nil) ? regularFont : boldFont;
                     [bolded addAttribute:NSFontAttributeName value:font range:range];
                   }];
    


    label.attributedText = bolded;

    Declaration

    Swift

    @NSCopying var attributedFullText: NSAttributedString { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSAttributedString *_Nonnull attributedFullText;

  • The main text of a prediction as a NSAttributedString, usually the name of the place. E.g. “Sydney Opera House”.

    Text ranges that match user input are have a kGMSAutocompleteMatchAttribute, like attributedFullText.

    Declaration

    Swift

    @NSCopying var attributedPrimaryText: NSAttributedString { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSAttributedString *_Nonnull attributedPrimaryText;

  • The secondary text of a prediction as a NSAttributedString, usually the location of the place. E.g. “Sydney, New South Wales, Australia”.

    Text ranges that match user input are have a kGMSAutocompleteMatchAttribute, like attributedFullText.

    May be nil.

    Declaration

    Swift

    @NSCopying var attributedSecondaryText: NSAttributedString? { get }

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSAttributedString *attributedSecondaryText;

  • A property representing the place ID of the prediction, suitable for use in a place details request.

    Declaration

    Swift

    var placeID: String { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull placeID;

  • The types of this autocomplete result. Types are NSStrings, valid values are any types documented at https://developers.google.com/places/ios-sdk/supported_types.

    Declaration

    Swift

    var types: [String] { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull types;

  • The straight line distance in meters between the origin and this prediction if a valid origin is specified in the GMSAutocompleteFilter of the request.

    Declaration

    Swift

    var distanceMeters: NSNumber? { get }

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *distanceMeters;

  • Unavailable

    Initializer is not available.

    Declaration

    Objective-C

    - (nonnull instancetype)init;