ExpoFP/com.expofp.fplan.api.app/IExpoFpPlanPresenter

IExpoFpPlanPresenter

interface IExpoFpPlanPresenter

Presenter for managing a specific plan.

Properties

additionalParams

abstract val additionalParams: List<URLQueryItem>

Parameters that were applied to the plan.

abstract val id: UUID

Presenter unique id.

locationProvider

abstract val locationProvider: IExpoFpLocationProvider?

Location provider that is currently in use.

planLink

abstract val planLink: ExpoFpLinkType

Link from which the plan was loaded.

planStatusFlow

abstract val planStatusFlow: Flow<ExpoFpPlanStatus>

A flow that notifies about plan loading statuses and navigation errors.

Functions

activateFloor

abstract fun activateFloor(floor: ExpoFpFloor)

Switch to the specified floor.

applyNewAdditionalParams

abstract fun applyNewAdditionalParams(params: List<URLQueryItem>)

New parameters will be applied immediately and saved in additionalParams.

boothsList

abstract suspend fun boothsList(): ExpoFpResult<List<ExpoFpBooth>>

Request plan booths (suspend version).

@MainThread

abstract fun boothsList(completion: (ExpoFpResult<List<ExpoFpBooth>>) -> Unit)

Request plan booths (callback version).

categoriesList

abstract suspend fun categoriesList(): ExpoFpResult<List<ExpoFpCategory>>

Request plan categories (suspend version).

@MainThread

abstract fun categoriesList(completion: (ExpoFpResult<List<ExpoFpCategory>>) -> Unit)

Request plan categories (callback version).

evaluateCustomScript

abstract suspend fun evaluateCustomScript(script: String): ExpoFpResult<Any?>

Execute custom script for DEBUG purposes (suspend version).

@MainThread

abstract fun evaluateCustomScript(script: String, completion: (ExpoFpResult<Any?>) -> Unit)

Execute custom script for DEBUG purposes (callback version).

exhibitorsList

abstract suspend fun exhibitorsList(): ExpoFpResult<List<ExpoFpExhibitor>>

Request plan exhibitors (suspend version).

@MainThread

abstract fun exhibitorsList(completion: (ExpoFpResult<List<ExpoFpExhibitor>>) -> Unit)

Request plan exhibitors (callback version).

findLocation

abstract fun findLocation()

Location search if location is enabled.

fitBounds

abstract fun fitBounds()

Display the plan within its boundaries.

getElementsVisibility

abstract suspend fun getElementsVisibility(): ExpoFpResult<ExpoFpElementsVisibility>

Request elements visibility info (suspend version).

@MainThread

abstract fun getElementsVisibility(completion: (ExpoFpResult<ExpoFpElementsVisibility>) -> Unit)

Request elements visibility info (callback version).

getFloors

abstract suspend fun getFloors(): ExpoFpResult<List<ExpoFpFloor>>

Request information about floors in a plan (suspend version).

@MainThread

abstract fun getFloors(completion: (ExpoFpResult<List<ExpoFpFloor>>) -> Unit)

Request information about floors in a plan (callback version).

getOptimizedRoutes

abstract suspend fun getOptimizedRoutes(waypoints: List<ExpoFpRouteWaypoint>): ExpoFpResult<List<ExpoFpRouteInfo>>

Optimize the constructed route (suspend version).

@MainThread

abstract fun getOptimizedRoutes(waypoints: List<ExpoFpRouteWaypoint>, completion: (ExpoFpResult<List<ExpoFpRouteInfo>>) -> Unit)

Optimize the constructed route (callback version).

getView

abstract fun getView(): View

Returns a View for displaying the plan.

highlightBooths

abstract fun highlightBooths(externalIds: List<String>)

Highlight the specified Booths by external IDs.

highlightExhibitors

abstract fun highlightExhibitors(externalIds: List<String>)

Highlight the specified Exhibitors by external IDs.

reloadPlan

abstract fun reloadPlan(planLink: ExpoFpLinkType? = null, additionalParams: List<URLQueryItem>? = null, locationProvider: IExpoFpLocationProvider? = null, messageListener: IExpoFpPlanMessageListener? = null)

Clear cache and reload the plan.

removeAdditionalParams

abstract fun removeAdditionalParams(keys: List<String>)

Parameters will be removed immediately for the given keys.

removeLocationProvider

abstract fun removeLocationProvider()

Removes current location provider from the plan and enables GPS.

removeMessageListener

abstract fun removeMessageListener()

Removes current message listener from the plan.

abstract suspend fun search(text: String): ExpoFpResult<List<ExpoFpSearchModel>>

Text search (suspend version).

@MainThread

abstract fun search(text: String, completion: (ExpoFpResult<List<ExpoFpSearchModel>>) -> Unit)

Text search (callback version).

selectBooth

abstract fun selectBooth(nameOrExternalId: String)

Select the specified Booth by name or external ID.

selectCategory

abstract fun selectCategory(name: String?)

Select the specified Category by name.

selectCurrentPosition

abstract fun selectCurrentPosition(position: ExpoFpPosition?, focus: Boolean = true)

Select the specified position and optionally focus on it.

selectExhibitor

abstract fun selectExhibitor(nameOrExternalId: String)

Select the specified Exhibitor by name or external ID.

selectRoute

abstract fun selectRoute(waypoints: List<ExpoFpRouteWaypoint>, onlyAccessible: Boolean = false)

Build the specified route.

setBookmarks

abstract fun setBookmarks(bookmarks: List<ExpoFpBookmark>)

Add or remove bookmarks.

setElementsVisibility

abstract fun setElementsVisibility(visibility: ExpoFpElementsVisibility)

Enable or disable elements visibility in the plan.

setLocationProvider

abstract fun setLocationProvider(provider: IExpoFpLocationProvider)

New location provider will be applied immediately.

setMessageListener

abstract fun setMessageListener(listener: IExpoFpPlanMessageListener)

Sets a new message listener for the plan. Note: IExpoFpPlanMessageListener is not retained.

switchView

abstract fun switchView()

Switch between 2D and 3D.

zoomIn

abstract fun zoomIn()

Zoom in the plan.

zoomOut

abstract fun zoomOut()

Zoom out the plan.