GooglePlaces Framework Reference

GMSAutocompleteFetcher

Deprecated

Use GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback: instead.

@interface GMSAutocompleteFetcher : NSObject

/**
 * Initialize the fetcher.
 *
 * @param filter The filter to apply to the results. This parameter may be nil.
 */
- (instancetype)initWithFilter:(nullable GMSAutocompleteFilter *)filter NS_DESIGNATED_INITIALIZER
    __GMS_AVAILABLE_BUT_DEPRECATED_MSG(
        "Use <code>GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback:</code> "
        "instead.")
        ;

/** Delegate to be notified with autocomplete prediction results. */
@property(nonatomic, weak, nullable) id<GMSAutocompleteFetcherDelegate> delegate
    __GMS_AVAILABLE_BUT_DEPRECATED_MSG(
        "Use <code>GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback:</code> "
        "instead.")
        ;

/** Filter to apply to autocomplete suggestions (can be nil). */
@property(nonatomic, strong, nullable) GMSAutocompleteFilter *autocompleteFilter
    __GMS_AVAILABLE_BUT_DEPRECATED_MSG(
        "Use <code>GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback:</code> "
        "instead.")
        ;

/** Provide a `GMSAutocompleteSessionToken` for tracking the specific autocomplete query flow. */
- (void)provideSessionToken:(nullable GMSAutocompleteSessionToken *)sessionToken
    __GMS_AVAILABLE_BUT_DEPRECATED_MSG(
        "Use <code>GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback:</code> "
        "instead.")
        ;

/**
 * Notify the fetcher that the source text to autocomplete has changed.
 *
 * This method should only be called from the main thread. Calling this method from another thread
 * will result in undefined behavior. Calls to `GMSAutocompleteFetcherDelegate` methods will also be
 * called on the main thread.
 *
 * This method is non-blocking.
 * @param text The partial text to autocomplete.
 */
- (void)sourceTextHasChanged:(nullable NSString *)text
    __GMS_AVAILABLE_BUT_DEPRECATED_MSG(
        "Use <code>GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback:</code> "
        "instead.")
        ;

@end

• -initWithFilter:

  Deprecated

  Use GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback: instead.

  Initialize the fetcher.

  Declaration

  Swift

  init(filter: GMSAutocompleteFilter?)

  Objective-C

  - (nonnull instancetype)initWithFilter:(nullable GMSAutocompleteFilter *)filter;

  Parameters

  filter

  The filter to apply to the results. This parameter may be nil.

• delegate

  Deprecated

  Use GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback: instead.

  Delegate to be notified with autocomplete prediction results.

  Declaration

  Swift

  weak var delegate: (any GMSAutocompleteFetcherDelegate)? { get set }

  Objective-C

  @property (nonatomic, weak, nullable) id<GMSAutocompleteFetcherDelegate> delegate;

• autocompleteFilter

  Deprecated

  Use GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback: instead.

  Filter to apply to autocomplete suggestions (can be nil).

  Declaration

  Swift

  var autocompleteFilter: GMSAutocompleteFilter? { get set }

  Objective-C

  @property (nonatomic, strong, nullable) GMSAutocompleteFilter *autocompleteFilter;

• -provideSessionToken:

  Deprecated

  Use GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback: instead.

  Provide a GMSAutocompleteSessionToken for tracking the specific autocomplete query flow.

  Declaration

  Swift

  func provide(_ sessionToken: GMSAutocompleteSessionToken?)

  Objective-C

  - (void)provideSessionToken:
      (nullable GMSAutocompleteSessionToken *)sessionToken;

• -sourceTextHasChanged:

  Deprecated

  Use GMSPlacesClient#fetchAutocompleteSuggestionsFromRequest:callback: instead.

  Notify the fetcher that the source text to autocomplete has changed.

  This method should only be called from the main thread. Calling this method from another thread will result in undefined behavior. Calls to GMSAutocompleteFetcherDelegate methods will also be called on the main thread.

  This method is non-blocking.

  Declaration

  Swift

  func sourceTextHasChanged(_ text: String?)

  Objective-C

  - (void)sourceTextHasChanged:(nullable NSString *)text;

  Parameters

  text	The partial text to autocomplete.