poi.navigation_places_controller.NavigationPlacesController Class Reference

Own one search session while sharing durable favorites and action adapters. More...

Inheritance diagram for poi.navigation_places_controller.NavigationPlacesController:

Public Member Functions
MapFavorite|None	favorite (self, str key)
	Return a saved shortcut destination.
None	search (self, PoiCategory category, TransitMode transit_mode=TransitMode.ALL)
	Request nearby places for the current viewport.
PoiSearchResult|None	poll_search_result (self)
	Consume a completed search.
PointOfInterest|None	poll_selected (self)
	Consume a selected place.
bool	poll_camera_interaction (self)
	Consume a native map interaction notification.
str	execute (self, PointOfInterest poi, PoiAction action)
	Perform a semantic place action using the backend platform adapter.
NavigationCameraState|None	poll_camera_state (self)
	Consume observed SI camera state.
int|None	request_action (self, PointOfInterest poi, PoiAction action)
	Start a handoff.
PlaceActionResult|None	poll_action_result (self)
	Consume a completed handoff.
None	clear (self)
	Invalidate pending searches and selections.
None	close (self)
	Idempotently release this view's search session.

Detailed Description

Own one search session while sharing durable favorites and action adapters.

Member Function Documentation

execute()

str poi.navigation_places_controller.NavigationPlacesController.execute	(		self,
		PointOfInterest	poi,
		PoiAction	action
	)

Perform a semantic place action using the backend platform adapter.

Parameters

poi	Selected place.
action	Requested action.

Returns

User-facing action status.

Exceptions

ValueError	When the action is invalid or unavailable.
RuntimeError	When the platform action fails.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

favorite()

MapFavorite | None poi.navigation_places_controller.NavigationPlacesController.favorite	(		self,
		str	key
	)

Return a saved shortcut destination.

Parameters

key	Shortcut name, home or work.

Returns

Saved location, or None when unconfigured.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

poll_action_result()

PlaceActionResult | None poi.navigation_places_controller.NavigationPlacesController.poll_action_result

(

self

)

Consume a completed handoff.

Returns

Completion or None.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

poll_camera_interaction()

bool poi.navigation_places_controller.NavigationPlacesController.poll_camera_interaction

(

self

)

Consume a native map interaction notification.

Returns

True when a manual camera interaction occurred.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

poll_camera_state()

NavigationCameraState | None poi.navigation_places_controller.NavigationPlacesController.poll_camera_state

(

self

)

Consume observed SI camera state.

Returns

Latest camera or None.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

poll_search_result()

PoiSearchResult | None poi.navigation_places_controller.NavigationPlacesController.poll_search_result

(

self

)

Consume a completed search.

Returns

Immutable search result, or None when none is pending.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

poll_selected()

PointOfInterest | None poi.navigation_places_controller.NavigationPlacesController.poll_selected

(

self

)

Consume a selected place.

Returns

Selected place, or None when none is pending.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

request_action()

int | None poi.navigation_places_controller.NavigationPlacesController.request_action	(		self,
		PointOfInterest	poi,
		PoiAction	action
	)

Start a handoff.

Parameters

poi	Place.
action	Action.

Returns

Request ID or None when busy.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

search()

None poi.navigation_places_controller.NavigationPlacesController.search	(		self,
		PoiCategory	category,
		TransitMode	transit_mode = TransitMode.ALL
	)

Request nearby places for the current viewport.

Parameters

category	Semantic place category.
transit_mode	Optional public transport filter.

Reimplemented from ui.navigation.navigation_places_request_handler_if.NavigationPlacesRequestHandlerIf.

---

The documentation for this class was generated from the following file:

• controllers/poi/navigation_places_controller.py