ФлотДвигатель

публичный класс FleetEngine расширяет объект

Клиент для Google Fleet Engine.

Этот класс позволяет вызывающей стороне enable и disableLocationTracking() отключая отслеживание местоположения. Частоту обновлений можно контролировать с помощью setLocationReportingInterval(long, TimeUnit) .

Этот класс не является потокобезопасным.

Сводка вложенных классов

интерфейс FleetEngine.AuthTokenFactory Экземплярам этого интерфейса будет предложено предоставить токен авторизации при выполнении различных операций.
сорт FleetEngine.ErrorListener Клиент Fleet Engine будет использовать экземпляры этого интерфейса, чтобы информировать разработчика о возникновении важных исключений.
интерфейс FleetEngine.FleetEngineConfig Этот интерфейс устарел. устаревший крючок
интерфейс FleetEngine.StatusListener Прослушиватель обновлений статуса.
перечисление FleetEngine.VehicleState Указывает, принимает ли транспортное средство новые поездки.

Краткое описание общедоступного метода

статическая пустота
очиститьэкземпляр ()
ClearInstance останавливает отслеживание местоположения, очищает внутреннее состояние и сбрасывает одноэлементный элемент FleetEngine в нулевое значение.
статическая пустота
createInstance (приложение-приложение, StringProviderId, String VehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.ErrorListener errorListener)
Создает синглтон FleetEngine , который можно использовать для доступа к сервису Google Fleet Engine.
статическая пустота
createInstance (приложение-приложение, StringProviderId, String VehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.StatusListener statusListener, FleetEngine.ErrorListener errorListener)
Создает синглтон FleetEngine , который можно использовать для доступа к сервису Google Fleet Engine.
пустота
отключитьLocationTracking ()
Останавливает отслеживание местоположения.
пустота
включитьLocationTracking ()
Начните загружать отчеты о местоположении в серверную часть Fleet Engine.
статический FleetEngine
получитьэкземпляр ()
Возвращает синглтон FleetEngine.
длинный
getLocationReportingIntervalMs ()
Возвращает текущий интервал передачи данных о местоположении в миллисекундах.
логическое значение
isLocationTrackingEnabled ()
Возвращает, включено ли отслеживание местоположения.
статическая пустота
setFleetEngineConfig (конфигурация FleetEngine.FleetEngineConfig )
пустота
setLocationReportingInterval (длинный интервал, TimeUnit periodUnits)
Устанавливает минимальный интервал, с которым отчеты о местоположении будут доставляться в серверную часть Fleet Engine.
статическая пустота
setNavigator ( навигатор навигатора)
пустота
setVehicleState (состояние FleetEngine.VehicleState )
Устанавливает состояние транспортного средства.

Сводка унаследованных методов

Публичные методы

public static voidclearInstance ( )

ClearInstance останавливает отслеживание местоположения, очищает внутреннее состояние и сбрасывает одноэлементный элемент FleetEngine в нулевое значение.

public static void createInstance (приложение-приложение, StringProviderId, String VehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.ErrorListener errorListener)

Создает синглтон FleetEngine , который можно использовать для доступа к сервису Google Fleet Engine. Внутренне этот метод получает RoadSnappedLocationProvider с помощью getRoadSnappedLocationProvider(Application) , поэтому перед вызовом этого метода необходимо успешно получить Navigator , иначе это приведет к возникновению IllegalStateException . Двойной вызов createInstance() приведет к возникновению IllegalStateException .

Параметры
приложение текущее Application не должно быть null
идентификатор поставщика идентификатор провайдера
идентификатор транспортного средства идентификатор транспортного средства, которое будет подключено к Fleet Engine
authTokenFactory factory , поставляющая токены авторизации Fleet Engine
прослушиватель ошибок listener , который будет уведомлен при возникновении ошибок клиента Fleet Engine
Броски
IllegalStateException если идентификатор провайдера не указан в AndroidManifest.xml

public static void createInstance (Приложение-приложение, StringProviderId, String VehicleId, FleetEngine.AuthTokenFactory authTokenFactory, FleetEngine.StatusListener statusListener, FleetEngine.ErrorListener errorListener)

Создает синглтон FleetEngine , который можно использовать для доступа к сервису Google Fleet Engine. Внутренне этот метод получает RoadSnappedLocationProvider с помощью getRoadSnappedLocationProvider(Application) , поэтому перед вызовом этого метода необходимо успешно получить Navigator , иначе это приведет к возникновению IllegalStateException . Двойной вызов createInstance() приведет к возникновению IllegalStateException .

Параметры
приложение текущее Application не должно быть null .
идентификатор поставщика идентификатор провайдера.
идентификатор транспортного средства идентификатор транспортного средства, которое будет подключено к Fleet Engine
authTokenFactory factory , поставляющая токены авторизации Fleet Engine.
статусСлушатель прослушиватель обновлений статуса.
прослушиватель ошибок listener , который будет уведомлен при возникновении ошибок клиента Fleet Engine.
Броски
IllegalStateException если идентификатор поставщика не указан в AndroidManifest.xml .

общественная недействительность отключитьLocationTracking ()

Останавливает отслеживание местоположения. Не предпринимается никаких попыток остановить уже выполняемый отчет, но новые отчеты о местоположении не создаются и не передаются.

Отслеживание можно возобновить после остановки, снова вызвав метод enableLocationTracking() .

Броски
IllegalStateException если отслеживание местоположения уже остановлено

общественная недействительность EnableLocationTracking ()

Начните загружать отчеты о местоположении в серверную часть Fleet Engine. Отчеты создаются периодически, по умолчанию каждые 5 секунд. Отчеты могут создаваться реже, если временные проблемы, такие как потеря сетевого подключения, препятствуют доставке отчетов.

Отчеты о позициях создаются в фоновом потоке, этот вызов возвращает результат немедленно.

Отслеживание местоположения можно отключить, вызвав метод disableLocationTracking() .

Интервал отчетности можно изменить с помощью setLocationReportingInterval(long, TimeUnit) .

Броски
IllegalStateException если отслеживание местоположения уже включено

общедоступный статический FleetEngine getInstance ()

Возвращает синглтон FleetEngine. createInstance() должен быть вызван до getInstance(), иначе будет возвращено значение null.

общедоступный длинный getLocationReportingIntervalMs ()

Возвращает текущий интервал передачи данных о местоположении в миллисекундах.

общедоступное логическое значение isLocationTrackingEnabled ()

Возвращает, включено ли отслеживание местоположения.

public static void setFleetEngineConfig (конфигурация FleetEngine.FleetEngineConfig )

Параметры
конфигурация

public void setLocationReportingInterval (длинный интервал, TimeUnit интервалUnits)

Устанавливает минимальный интервал, с которым отчеты о местоположении будут доставляться в серверную часть Fleet Engine. Интервал отчетов по умолчанию составляет 10 секунд. Минимальный поддерживаемый интервал обновления составляет 5 секунд. Более частые обновления могут привести к замедлению запросов и ошибкам.

Параметры
интервал
интервалЕдиницы

public static void setNavigator ( навигатор навигатора)

Параметры
штурман

public void setVehicleState (состояние FleetEngine.VehicleState )

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

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

Параметры
состояние
Броски
IllegalStateException если VehicleState установлен в режиме ONLINE, когда отслеживание местоположения еще не включено.