GMSAutocompleteFetcher クラス リファレンス

GMSAutocompleteFetcher クラス リファレンス

概要

GMSAutocompleteFetcher は、下位レベルのオートコンプリート API のラッパーで、ユーザーが入力する際にオートコンプリート候補をリクエストする複雑な作業をカプセル化しています。

sourceTextHasChanged を呼び出すと、通常、指定されたデリゲートが、クエリされたテキストのオートコンプリート予測とともに呼び出されます。ただし、次の条件が適用されます。

  • 短時間に複数のリクエストが行われた場合、フェッチャーは、sourceTextHasChanged の呼び出しごとに予測をリクエストするとは限りません。
  • デリゲートは、その予測が、最後に sourceTextHasChanged の呼び出しで提供されたテキストに対するものである場合にのみ、予測結果とともに呼び出されます。

パブリック メンバー関数

(instancetype)- initWithFilter:
 フェッチャーを初期化します。
(void) - provideSessionToken:
 特定のオートコンプリート クエリフローをトラッキングするための GMSAutocompleteSessionToken を指定します。
(void) - sourceTextHasChanged:
 オートコンプリートのソーステキストが変更されたことをフェッチャーに通知します。

プロパティ

id
< GMSAutocompleteFetcherDelegate >
委任
 オートコンプリート予測結果の通知を受け取るように委任します。
GMSAutocompleteFilterautocompleteFilter
 オートコンプリートの候補に適用するフィルタ(nil にすることもできます)。

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

-(インスタンス タイプ)initWithFilter: (null 許容 GMSAutocompleteFilter *) filter

フェッチャーを初期化します。

パラメータ:
フィルタ結果に適用するフィルタ。このパラメータは nil にすることもできます。
-(void)provideSessionToken: (null 許容の GMSAutocompleteSessionToken *) sessionToken

特定のオートコンプリート クエリフローをトラッキングするための GMSAutocompleteSessionToken を指定します。

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

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

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

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

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

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

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

オートコンプリート予測結果の通知を受け取るように委任します。

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

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