GMSNavigationSession Class Reference

GMSNavigationSession Class Reference

Overview

This class provides a set of related objects that can be used to programmatically control a navigation session.

Properties

BOOL started
 Whether or not navigation on this session is started.
GMSNavigationTravelMode travelMode
 The travel mode for this session.
GMSLocationSimulatorlocationSimulator
 An instance of GMSLocationSimulator which can be used to simulate locations for this session, or nil if terms and conditions have not been accepted.
GMSNavigatornavigator
 The instance of GMSNavigator managing this navigation session, or nil if terms and conditions have not been accepted.
GMSRoadSnappedLocationProviderroadSnappedLocationProvider
 The road-snapped location provider for this session, or nil if terms and conditions have not been accepted.

Property Documentation

- (BOOL) started [read, write, assign]

Whether or not navigation on this session is started.

A session cannot be started unless terms and conditions have previously been accepted.

Starting a session is a prerequisite for activating guidance on the session's navigator, or for starting location updates from the session's road-snapped location provider.

A started session receives location from CoreLocation as determined by the application's location authorization. Your app can temporarily stop the Navigation SDK from requesting location updates. For instance, it might do this in order to reduce battery usage in a period when location updates are known to be unnecessary.

- (GMSNavigationTravelMode) travelMode [read, write, assign]

The travel mode for this session.

An instance of GMSLocationSimulator which can be used to simulate locations for this session, or nil if terms and conditions have not been accepted.

- (GMSNavigator*) navigator [read, assign]

The instance of GMSNavigator managing this navigation session, or nil if terms and conditions have not been accepted.

The road-snapped location provider for this session, or nil if terms and conditions have not been accepted.