GMSAutocompleteTableDataSource クラス リファレンス

GMSAutocompleteTableDataSource クラス リファレンス

概要

GMSAutocompleteTableDataSource は、UITableViewDataSource プロトコルと UITableViewDelegate プロトコルを実装して、UITableView にデータを入力する Place Autocomplete の予測機能を提供するインターフェースを提供します。

GMSAutocompleteTableDataSource は、UISearchDisplayController のデータソースとして使用するように設計されています。

注:
UISearchDisplayController は iOS 8 でサポートが終了しています。iOS 検索 UI を使用してオートコンプリートの結果を表示するには、GMSAutocompleteResultsViewController で UISearchController を使用することをおすすめします。

GMSAutocompleteTableDataSource のインスタンスを、UISearchDisplayController の searchResultsDataSource プロパティと searchResultsDelegate プロパティとして設定します。shouldRecognizeTableForSearchString の実装で、現在の検索文字列を使用して sourceTextHasChanged を呼び出します。

リストから場所が選択された際に通知を受け取るには、GMSAutocompleteTableDataSourceDelegate デリゲート プロトコルを使用します。オートコンプリート予測は非同期で読み込まれるため、UISearchDisplayController のテーブルビューで DidUpdateAutocompletePredictions を実装し、reloadData を呼び出す必要があります。

パブリック メンバー関数

(instancetype)- init
 データソースを初期化します。
(void) - sourceTextHasChanged:
 オートコンプリートのソーステキストが変更されたことをデータソースに通知します。
(void) - clearResults
 すべての予測を消去します。

プロパティ

IBOutlet ID
< GMSAutocompleteTableDataSourceDelegate >
委任
 場所が選択されたか、選択がキャンセルされたときに通知が届くように委任します。
GMSAutocompleteFilterautocompleteFilter
 オートコンプリートの候補に適用するフィルタ(nil にすることもできます)。
UIColor * tableCellBackgroundColor
 表のセルの背景色。
UIColor * tableCellSeparatorColor
 表のセルを区切る線の色。
UIColor * primaryTextColor
 オートコンプリートの結果に表示される結果名のテキストの色。
UIColor * primaryTextHighlightColor
 オートコンプリートの結果として一致するテキストをハイライト表示するために使用される色。
UIColor * secondaryTextColor
 オートコンプリートの結果に表示される 2 行目のテキストの色。
UIColor * tintColor
 オートコンプリート ビューのコントロールに適用される色合い。
GMSPlaceFieldplaceFields
 リクエストする場所の詳細を明示的に指定する場合の GMSPlaceField

メンバー関数のドキュメント

-(instancetype)init

データソースを初期化します。

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

オートコンプリートのソーステキストが変更されたことをデータソースに通知します。

このメソッドを呼び出せるのは、メインスレッドからのみです。別のスレッドからこのメソッドを呼び出すと、未定義の動作になります。GMSAutocompleteTableDataSourceDelegate メソッドの呼び出しもメインスレッドで呼び出されます。

このメソッドは非ブロックです。

パラメータ:
指定していますオートコンプリートするテキストの一部。
-(void)clearResults

すべての予測を消去します。

注:
これにより、以下の 2 つのデリゲート メソッドを呼び出します。
  • didUpdateAutocompletePredictionsForResultsController:
  • didRequestAutocompletePredictionsForResultsController:

このメソッドの実装では、これらを同期的に順番に呼び出すことが保証されています。


プロパティのドキュメント

- (IBOutlet id<GMSAutocompleteTableDataSourceDelegate>) delegate [read, write, assign]

場所が選択されたか、選択がキャンセルされたときに通知が届くように委任します。

-(GMSAutocompleteFilter*)autocompleteFilter [read, write, assign]

オートコンプリートの候補に適用するフィルタ(nil にすることもできます)。

-(UIColor*)tableCellBackgroundColor [read, write, assign]

表のセルの背景色。

-(UIColor*)tableCellSeparatorColor [read, write, assign]

表のセルを区切る線の色。

-(UIColor*)primaryTextColor [read, write, assign]

オートコンプリートの結果に表示される結果名のテキストの色。

-(UIColor*)primaryTextHighlightColor [read, write, assign]

オートコンプリートの結果として一致するテキストをハイライト表示するために使用される色。

- (UIColor*) secondaryTextColor [read, write, assign]

オートコンプリートの結果に表示される 2 行目のテキストの色。

-(UIColor*)tintColor [read, write, assign]

オートコンプリート ビューのコントロールに適用される色合い。

- (GMSPlaceFieldplaceFields [read, write, assign]

リクエストする場所の詳細を明示的に指定する場合の GMSPlaceField

デフォルトでは、使用可能なすべてのフィールドが返されます。