Справочник по классу GMSPlacesClient

Открытые функции-члены | Статические открытые функции-члены | Связанные функции
Справочник по классу GMSPlacesClient

Обзор

Основной интерфейс Places SDK.

Используется для поиска и получения подробной информации о местах. Доступ к этому классу должен осуществляться через метод [ GMSPlacesClientsharedClient ].

Методы GMSPlacesClient следует вызывать только из основного потока. Вызов этих методов из другого потока приведет к исключению или неопределенному поведению. Если не указано иное, все обратные вызовы будут вызываться в основном потоке.

Открытые функции-члены

(пустота) - LookUpPlaceID: обратный вызов:
Получите подробную информацию о месте.
(пустота) - fetchAutocompleteSuggestionsFromRequest: обратный вызов:
Найдите предложения автозаполнения из текстового запроса.
(пустота) - LookUpPhotosForPlaceID: обратный вызов:
Получает метаданные максимум для 10 фотографий, связанных с местом.
(пустота) - loadPlacePhoto: обратный вызов:
Загружает изображение для конкретной фотографии в максимальном размере.
(пустота) - loadPlacePhoto:constrainedToSize:масштаб:обратный вызов:
Загружает изображение для конкретной фотографии, масштабированное в соответствии с заданными максимальными размерами.
(пустота) - currentPlaceWithCallback:
Возвращает оценку места, где в данный момент находится устройство.
(пустота) - findAutocompletePredictionsFromQuery:фильтр:sessionToken:обратный вызов:
Найдите подсказки автозаполнения из текстового запроса.
(пустота) - fetchPlaceFromPlaceID:placeFields:sessionToken:обратный вызов:
Получить подробную информацию о месте.
(пустота) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: обратный вызов:
Найдите вероятность места, используя текущее местоположение пользователя.
(пустота) - isOpenWithRequest: обратный вызов:
Получает открытый статус места.
(пустота) - isOpenWithPlaceID: обратный вызов:
Получает сведения о месте, включая все поля, необходимые для определения GMSPlaceOpenStatus в текущий момент.
(пустота) - isOpenWithPlaceID:дата:обратный вызов:
Получает сведения о месте, включая все поля, необходимые для определения GMSPlaceOpenStatus в указанный NSDate .
(пустота) - isOpenWithPlace: обратный вызов:
Получает сведения о месте, включая все поля, необходимые для определения GMSPlaceOpenStatus в текущий момент.
(пустота) - isOpenWithPlace:дата:обратный вызов:
Получает сведения о месте, включая все поля, необходимые для определения GMSPlaceOpenStatus в указанный NSDate .
(пустота) - searchByTextWithRequest: обратный вызов:
Поиск мест по тексту и ограничениям.
(пустота) - fetchPlaceWithRequest: обратный вызов:
Получите место, используя объект запроса.
(пустота) - fetchPhotoWithRequest: обратный вызов:
Запросите фотографию, используя запрос фотографии.
(пустота) - searchNearbyWithRequest: обратный вызов:
Поиск мест рядом с локацией и ограничением.

Статические открытые функции-члены

(тип экземпляра) + общий клиент
Предоставляет общий экземпляр GMSPlacesClient для Google Places SDK для iOS, создавая его при необходимости.
(БУЛ) + предоставитьAPIKey:
Предоставляет ваш ключ API для Google Places SDK для iOS.
(НСтрока *) + openSourceLicenseInfo
Возвращает информацию о лицензии на программное обеспечение с открытым исходным кодом для Google Places SDK для iOS.
(НСтрока *) + SDKВерсия
Возвращает версию этого выпуска Google Places SDK для iOS.
(НСтрока *) + SDKLongVersion
Возвращает полную версию этого выпуска Google Places SDK для iOS.

(Обратите внимание, что это не функции-члены.)

typedef void(^ GMSPlaceResultCallback )(Результат GMSPlace *_Nullable, NSError *_Nullable ошибка)
Тип обратного вызова для получения информации о месте.
typedef void(^ GMSPlaceLikelihoodListCallback )( GMSPlaceLikelihoodList *_Nullable правдоподобиеList, NSError *_Nullable ошибка)
Тип обратного вызова для получения списков вероятности мест.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable вероятности, NSError *_Nullable error)
Тип обратного вызова для получения массива GMSPlaceLikelihood .
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable результаты, NSError *_Nullable error)
Тип обратного вызова для получения результатов автозаполнения.
typedef void(^ GMSPlacePhotoMetadataResultCallback )( GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
Тип обратного звонка для получения результатов фотографий места.
typedef void(^ GMSPlacePhotoImageResultCallback ) (фотография UIImage *_Nullable, ошибка NSError *_Nullable)
Тип обратного вызова для получения объектов UIImage из объекта GMSPlacePhotoMetadata .
typedef void(^ GMSPlaceOpenStatusCallback )(результат GMSPlaceOpenStatus , ошибка NSError *_Nullable)
Тип обратного вызова для получения статуса часов работы места.
typedef void(^ GMSPlaceOpenStatusResponseCallback )( GMSPlaceIsOpenResponse *response, NSError *_Nullable error)
Тип обратного вызова для получения ответа об открытом статусе.
typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable мест, NSError *_Nullable error)
Тип обратного вызова для получения результатов поиска по тексту.
typedef void(^ GMSFetchPhotoResultCallback )(UIImage *_Nullable photoImage, NSError *_Nullable error)
Тип обратного звонка для получения фото.
typedef void(^ GMSAutocompleteSuggestionsCallback )(NSArray< GMSAutocompleteSuggestion * > *_Nullable результаты, NSError *_Nullable error)
Тип обратного вызова для результатов автозаполнения.
typedef void(^ GMSPlaceSearchNearbyResultCallback )(NSArray< GMSPlace * > *_Nullable мест, NSError *_Nullable error)
Тип обратного вызова для получения результатов поиска поблизости.

Документация по функциям-членам

+ (тип экземпляра) общий клиент

Предоставляет общий экземпляр GMSPlacesClient для Google Places SDK для iOS, создавая его при необходимости.

Если ваше приложение часто использует методы GMSPlacesClient , оно может захотеть напрямую удерживать этот объект, иначе ваше соединение с Google может регулярно перезапускаться.

+ (BOOL) предоставитьAPIKey: (НСтрока *) ключ

Предоставляет ваш ключ API для Google Places SDK для iOS.

Этот ключ генерируется для вашего приложения через консоль Google Cloud Platform и связывается с идентификатором пакета вашего приложения для его идентификации. Это должно быть вызвано вашим приложением перед использованием GMSPlacesClient (например, в application:didFinishLaunchingWithOptions:).

Возврат:
ДА, если APIKey был успешно предоставлен.
+ (NSString *) openSourceLicenseInfo

Возвращает информацию о лицензии на программное обеспечение с открытым исходным кодом для Google Places SDK для iOS.

Эта информация должна быть доступна в вашем приложении.

+ (NSString *) SDKVersion

Возвращает версию этого выпуска Google Places SDK для iOS.

. Например, «1.0.0».

+ (NSString *) SDKLongVersion

Возвращает полную версию этого выпуска Google Places SDK для iOS.

. Например, «1.0.0 (102.1)».

- (недействительно) LookUpPlaceID: (НСтрока *) идентификатор места
перезвонить: ( GMSPlaceResultCallback ) перезвонить

Получите подробную информацию о месте.

Этот метод неблокирующий.

Параметры:
идентификатор места Идентификатор места для поиска.
перезвонить Обратный вызов, который необходимо вызвать с результатом поиска.
Примечание:
Это устарело. Этот метод заменен на fetchPlaceWithRequest:callback: и будет удален в будущем выпуске.
- (void) fetchAutocompleteSuggestionsFromRequest: ( GMSAutocompleteRequest *) запрос
перезвонить: ( GMSAutocompleteSuggestionsCallback ) перезвонить

Найдите предложения автозаполнения из текстового запроса.

Результаты могут при желании быть смещены в сторону определенного местоположения или ограничены областью. Этот метод неблокирующий.

Предоставленный обратный вызов будет вызван с массивом предложений автозаполнения в случае успеха и NSError в случае ошибки.

Параметры:
запрос Запрос GMSAutocompleteRequest для автозаполнения.
перезвонить Обратный вызов для вызова с предложениями.
- (недействительно) LookUpPhotosForPlaceID: (НСтрока *) идентификатор места
перезвонить: ( GMSPlacePhotoMetadataResultCallback ) перезвонить

Получает метаданные максимум для 10 фотографий, связанных с местом.

Фотографии взяты из разных источников, включая фотографии владельцев бизнеса и пользователей Google+. В большинстве случаев эти фотографии можно использовать без указания авторства или они будут иметь необходимое указание авторства как часть изображения. Однако вы должны использовать свойство attributions в ответе, чтобы получить любые необходимые дополнительные атрибуции и отображать эти атрибуции в своем приложении, где бы вы ни отображали изображение. Возвращается максимум 10 фотографий.

Множественные вызовы этого метода, вероятно, каждый раз будут возвращать одни и те же фотографии. Однако это не гарантируется, поскольку базовые данные могли измениться.

Этот метод выполняет поиск в сети.

Параметры:
идентификатор места Идентификатор места, по которому нужно искать фотографии.
перезвонить Обратный вызов, который необходимо вызвать с результатом поиска.
- (недействительно) loadPlacePhoto: ( GMSPlacePhotoMetadata *) фотоМетаданные
перезвонить: ( GMSPlacePhotoImageResultCallback ) перезвонить

Загружает изображение для конкретной фотографии в максимальном размере.

Данные изображения могут кэшироваться SDK. Если запрошенная фотография не существует в кеше, будет выполнен поиск в сети.

Параметры:
фотоМетаданные GMSPlacePhotoMetadata для которого нужно загрузить UIImage .
перезвонить Обратный вызов для вызова с загруженным UIImage .
- (недействительно) loadPlacePhoto: ( GMSPlacePhotoMetadata *) фотоМетаданные
ограниченоToSize: (CGSize) МаксСизе
шкала: (CGFloat) шкала
перезвонить: ( GMSPlacePhotoImageResultCallback ) перезвонить

Загружает изображение для конкретной фотографии, масштабированное в соответствии с заданными максимальными размерами.

Изображение будет масштабировано в соответствии с заданными размерами, сохраняя при этом соотношение сторон исходного изображения. Это масштабирование выполняется на стороне сервера.

Если параметр масштаба не равен 1,0, maxSize будет умножен на это значение, и возвращаемый UIImage будет иметь указанный масштаб. Этот параметр должен быть установлен в соответствии с масштабом экрана, если вы загружаете изображения для отображения на экране.

Данные изображения могут кэшироваться SDK. Если запрошенная фотография не существует в кеше, будет выполнен поиск в сети.

Примечание:
После применения масштабного коэффициента размеры в maxSize перед использованием будут округлены до ближайшего целого числа. Если запрошено изображение, размер которого превышает максимально доступный размер, может быть возвращено изображение меньшего размера.
Параметры:
фотоМетаданные GMSPlacePhotoMetadata для которого нужно загрузить UIImage .
МаксСизе Максимальный размер изображения.
шкала Масштаб для загрузки изображения.
перезвонить Обратный вызов для вызова с загруженным UIImage .
- (недействительно) currentPlaceWithCallback: ( GMSPlaceLikelihoodListCallback ) перезвонить

Возвращает оценку места, где в данный момент находится устройство.

Создает список вероятностей мест на основе последнего предполагаемого местоположения устройства. Предоставленный обратный вызов будет вызван с этим списком вероятности в случае успеха и с NSError в случае ошибки.

Примечание:
Для этого метода требуется, чтобы у вашего приложения было разрешение на доступ к текущему местоположению устройства. Прежде чем вызывать это, обязательно запросите доступ к местоположению пользователей с помощью [CLLocationManager requestWhenInUseAuthorization] или [CLLocationManager requestAlwaysAuthorization]. Если вы вызываете этот метод и ваше приложение не имеет правильного статуса авторизации, обратный вызов будет вызван с ошибкой.
Параметры:
перезвонить Обратный вызов для вызова со списком вероятности места.
- (void) findAutocompletePredictionsFromQuery: (НСтрока *) запрос
фильтр: (обнуляемый GMSAutocompleteFilter *) фильтр
сессионный токен: (обнуляемый GMSAutocompleteSessionToken *) сессионный токен
перезвонить: ( GMSAutocompletePredictionsCallback ) перезвонить

Найдите подсказки автозаполнения из текстового запроса.

Результаты могут при желании быть смещены в сторону определенного местоположения или ограничены областью. Этот метод неблокирующий.

Предоставленный обратный вызов будет вызван с массивом прогнозов автозаполнения в случае успеха и NSError в случае ошибки.

Параметры:
запрос Частичный текст для автозаполнения.
фильтр Фильтр, применяемый к результатам. Этот параметр может быть нулевым.
сессионный токен GMSAutocompleteSessionToken для связи запроса с сеансом выставления счетов.
перезвонить Обратный вызов для вызова с прогнозами.
- (недействительно) fetchPlaceFromPlaceID: (НСтрока *) идентификатор места
МестоПоля: ( ГМСплацефилд ) местоПоля
сессионный токен: (обнуляемый GMSAutocompleteSessionToken *) сессионный токен
перезвонить: ( GMSPlaceResultCallback ) перезвонить

Получить подробную информацию о месте.

Этот метод неблокирующий.

Параметры:
идентификатор места Идентификатор места для поиска.
местоПоля Отдельные поля места, запрошенные для объектов места в списке.
сессионный токен GMSAutocompleteSessionToken для связи запроса с сеансом выставления счетов.
перезвонить Обратный вызов, который необходимо вызвать с результатом поиска.
Примечание:
Это устарело. Этот метод заменен на fetchPlaceWithRequest:callback: callback: и будет удален в будущем выпуске.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: ( ГМСплацефилд ) местоПоля
перезвонить: ( GMSPlaceLikelihoodsCallback ) перезвонить

Найдите вероятность места, используя текущее местоположение пользователя.

Этот метод неблокирующий.

Предоставленный обратный вызов будет вызван с массивом мест с оценками вероятности в случае успеха и NSError в случае ошибки.

Параметры:
местоПоля Отдельные поля места, запрошенные для объектов места в списке.
перезвонить Обратный вызов для вызова с вероятностью места.
- (недействительно) isOpenWithRequest: ( GMSPlaceIsOpenRequest *) isOpenRequest
перезвонить: ( GMSPlaceOpenStatusResponseCallback ) перезвонить

Получает открытый статус места, включая все свойства, необходимые для определения GMSPlaceOpenStatus в указанный NSDate. Этот метод неблокирующий.

Параметры:
isOpenRequest Запрос на определение открытого статуса для данного места.
перезвонить Обратный вызов, который необходимо вызвать с ответом об открытом статусе.
- (недействительно) isOpenWithPlaceID: (НСтрока *) идентификатор места
перезвонить: ( GMSPlaceOpenStatusCallback ) перезвонить

Получает открытый статус места, включая все поля, необходимые для определения GMSPlaceOpenStatus в текущий момент.

Этот метод неблокирующий.

Параметры:
идентификатор места Идентификатор места для поиска.
перезвонить Обратный вызов для вызова с результатом размещения.
- (недействительно) isOpenWithPlaceID: (НСтрока *) идентификатор места
дата: (НСДата *) дата
перезвонить: ( GMSPlaceOpenStatusCallback ) перезвонить

Получает статус открытия места, включая все поля, необходимые для определения GMSPlaceOpenStatus в указанный NSDate .

Этот метод неблокирующий.

Параметры:
идентификатор места Идентификатор места для поиска.
дата NSDate для определения открытого статуса.
перезвонить Обратный вызов для вызова с результатом размещения.
- (недействительно) isOpenWithPlace: ( GMSPlace *) место
перезвонить: ( GMSPlaceOpenStatusCallback ) перезвонить

Получает открытый статус места, включая все поля, необходимые для определения GMSPlaceOpenStatus в текущий момент.

Запрашивает дополнительные поля только в том случае, если GMSPlace не имеет всех необходимых полей, в противном случае GMSPlaceOpenStatus будет немедленно возвращен в обратном вызове. Этот метод неблокирующий.

Параметры:
место GMSPlace для поиска.
перезвонить Обратный вызов для вызова с результатом размещения.
- (недействительно) isOpenWithPlace: ( GMSPlace *) место
дата: (НСДата *) дата
перезвонить: ( GMSPlaceOpenStatusCallback ) перезвонить

Получает сведения о месте, включая все поля, необходимые для определения GMSPlaceOpenStatus в указанный NSDate .

Запрашивает дополнительные поля только в том случае, если GMSPlace не имеет всех необходимых полей, в противном случае GMSPlaceOpenStatus\ will be returned in the callback immediately. This method is non-blocking.

Параметры:
место GMSPlace для поиска.
дата NSDate для определения открытого статуса.
перезвонить Обратный вызов для вызова с результатом размещения.

- (недействительно) searchByTextWithRequest: ( GMSPlaceSearchByTextRequest *) текстПоискЗапрос
перезвонить: ( GMSPlaceSearchByTextResultCallback ) перезвонить

Поиск мест по тексту и ограничениям.

Этот метод неблокирующий.

Параметры:
текстПоискЗапрос GMSPlaceSearchByTextRequest Текстовый запрос, используемый для запроса.
перезвонить Обратный вызов, который необходимо вызвать с результатом поиска.
- (недействительно) fetchPlaceWithRequest: ( ГМСфетчплацерекуест *) fetchPlaceRequest
перезвонить: ( GMSPlaceResultCallback ) перезвонить

Получите место, используя объект запроса.

Этот метод неблокирующий.

Параметры:
fetchPlaceRequest GMSFetchPlaceRequest Запрос места выборки, используемый для запроса.
перезвонить Обратный вызов для вызова с результатом размещения.
- (недействительно) fetchPhotoWithRequest: ( ГМСФетчФоторекуест *) выборкаФотоЗапрос
перезвонить: ( GMSFetchPhotoResultCallback ) перезвонить

Запросите фотографию, используя запрос фотографии.

Этот метод неблокирующий.

Параметры:
выборкаФотоЗапрос GMSFetchPhotoRequest Используемый запрос фотографии.
перезвонить Обратный вызов для вызова с результатом NSURL .
- (void) searchNearbyWithRequest: ( GMSPlaceSearchNearbyRequest *) поискРядомЗапрос
перезвонить: ( GMSPlaceSearchNearbyResultCallback ) перезвонить

Поиск мест рядом с локацией и ограничением.

Этот метод неблокирующий.

Параметры:
поискРядомЗапрос GMSPlaceSearchNearbyRequest Запрос на поиск поблизости, используемый для запроса.
перезвонить Обратный вызов, который необходимо вызвать с результатом поиска.
- (typedef void(^ GMSPlaceResultCallback )(результат GMSPlace *_Nullable, NSError *_Nullable error)) [related]

Тип обратного вызова для получения информации о месте.

Если произошла ошибка, result будет нулевым, а error будет содержать информацию об ошибке.

Параметры:
результат Возвращенное GMSPlace .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlaceLikelihoodListCallback )( GMSPlaceLikelihoodList *_Nullable правдоподобиеList, NSError *_Nullable error)) [related]

Тип обратного вызова для получения списков вероятности мест.

Если произошла ошибка, likelihoodList будет равен нулю, а error будет содержать информацию об ошибке.

Параметры:
ВероятностьСписок Список вероятностей мест.
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable вероятности, NSError *_Nullable error)) [related]

Тип обратного вызова для получения массива GMSPlaceLikelihood .

Если произошла ошибка, массив будет равен нулю, а error будет содержать информацию об ошибке.

- (typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable результаты, NSError *_Nullable error)) [related]

Тип обратного вызова для получения результатов автозаполнения.

results — это массив GMSAutocompletePredictions, представляющий возможные варианты завершения запроса.

Параметры:
результаты Массив GMSAutocompletePrediction .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback )( GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Тип обратного звонка для получения результатов фотографий места.

Если произошла ошибка, photos будут нулевыми, а error будет содержать информацию об ошибке.

Параметры:
фотографии Результат, содержащий объекты GMSPlacePhotoMetadata .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable фото, NSError *_Nullable error)) [related]

Тип обратного вызова для получения объектов UIImage из объекта GMSPlacePhotoMetadata .

Если произошла ошибка, photo будет нулевой, а error будет содержать информацию об ошибке.

Параметры:
фото UIImage , который был загружен.
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlaceOpenStatusCallback )(результат GMSPlaceOpenStatus , ошибка NSError *_Nullable)) [related]

Тип обратного вызова для получения статуса часов работы места.

Если произошла ошибка, result будет GMSPlaceOpenStatusUnknown, а error будет содержать информацию об ошибке.

Параметры:
результат Возвращенный GMSPlaceOpenStatus .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlaceOpenStatusResponseCallback )( GMSPlaceIsOpenResponse *response, NSError *_Nullable error)) [related]

Тип обратного вызова для получения ответа об открытом статусе.

Если произошла ошибка, ответ будет иметь статус GMSPlaceOpenStatusUnknown, а ошибка будет содержать информацию об ошибке.

Параметры:
ответ Возвращенный GMSPlaceIsOpenResponse .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable мест, NSError *_Nullable error)) [related]

Тип обратного вызова для получения результатов поиска по тексту.

results — это массив GMSPlace, представляющий отдельные результаты, соответствующие запросу.

Параметры:
результаты Массив GMSPlace .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSFetchPhotoResultCallback )(UIImage *_Nullable photoImage, NSError *_Nullable error)) [related]

Тип обратного звонка для получения фото.

photoImage — это UIImage представляющий результирующую фотографию, соответствующую указанному запросу. Если произошла ошибка, photoImage будет равно нулю, а error будет содержать информацию об ошибке.

Параметры:
фотоИзображение Результат UIImage .
- (typedef void(^ GMSAutocompleteSuggestionsCallback )(NSArray< GMSAutocompleteSuggestion * > *_Nullable результаты, NSError *_Nullable error)) [related]

Тип обратного вызова для результатов автозаполнения.

Параметры:
результаты Массив GMSAutocompleteSuggestion .
ошибка Произошла ошибка, если таковая имеется.
- (typedef void(^ GMSPlaceSearchNearbyResultCallback )(NSArray< GMSPlace * > *_Nullable мест, NSError *_Nullable error)) [related]

Тип обратного вызова для получения результатов поиска поблизости.

Параметры:
места Массив GMSPlace
ошибка Произошла ошибка, если таковая имеется.