/tripkit/TripKitAndroidUI/com.skedgo.tripkit.ui.map.home/TripKitMapFragment

TripKitMapFragment

\ class TripKitMapFragment : LocationEnhancedMapFragment, GoogleMap.OnInfoWindowClickListener, GoogleMap.OnMapLongClickListener, GoogleMap.OnPoiClickListener, GoogleMap.OnCameraChangeListener, GoogleMap.OnMarkerClickListener, GoogleMap.OnCameraIdleListener

A map component for an app. It automatically integrates with SkedGo's backend, display transit information without any additional intervention.

Being a fragment, it can very easily be added to an activity's layout.

 ` ` 

Your app must provide a TripGo API token as R.string.skedgo_api_key.

Constructors

TripKitMapFragment constructor()

Types

Name Summary
Companion object Companion
OnInfoWindowClickListener interface OnInfoWindowClickListener
When an icon in the map is clicked, an information window is displayed. When that information window is clicked, this interface is used as a callback to notify the app of the click.
OnZoomLevelChangedListener interface OnZoomLevelChangedListener

Properties

Name Summary
appDeactivatedListener var appDeactivatedListener: () -> Unit?
cameraController @Inject
lateinit var cameraController: MapCameraController
cityInfoWindowAdapter @Inject
lateinit var cityInfoWindowAdapter: CityInfoWindowAdapter
enablePinLocationOnClick var enablePinLocationOnClick: Boolean
errorLogger @Inject
lateinit var errorLogger: ErrorLogger
eventTracker @Inject
lateinit var eventTracker: EventTracker
locationStream @Inject
lateinit var locationStream: Observable<Location>
myLocationWindowAdapter @Inject
lateinit var myLocationWindowAdapter: NoActionWindowAdapter
pinForType var pinForType: Int
pinLocationSelectedListener var pinLocationSelectedListener: (Location, Int) -> Unit?
pinnedDepartureLocation var pinnedDepartureLocation: Location?
pinnedDepartureLocationOnClickMarker var pinnedDepartureLocationOnClickMarker: Marker?
pinnedOriginLocation var pinnedOriginLocation: Location?
pinnedOriginLocationOnClickMarker var pinnedOriginLocationOnClickMarker: Marker?
preferences @Inject
lateinit var preferences: SharedPreferences
regionService @Inject
lateinit var regionService: RegionService
stopMarkerIconFetcherLazy @Inject
lateinit var stopMarkerIconFetcherLazy: Lazy<StopMarkerIconFetcher>
tripLocationMarkerCreator @Inject
lateinit var tripLocationMarkerCreator: TripLocationMarkerCreator
viewModel @Inject
lateinit var viewModel: MapViewModel

Functions

Name Summary
addOriginDestinationMarker fun addOriginDestinationMarker(type: Int, location: Location)
animateToCity fun animateToCity(city: Location)
animateToMyLocation open override fun animateToMyLocation()
changeActionsAccessibilityFocus fun changeActionsAccessibilityFocus(canBeAccessed: Boolean)
dump open fun dump(@NonNullp0: String, @Nullablep1: FileDescriptor?, @NonNullp2: PrintWriter, @Nullablep3: Array<String>?)
equals operator override fun equals(@Nullableother: Any?): Boolean
fetchCurrentPositionMarkers fun fetchCurrentPositionMarkers()
focusOnLocation fun focusOnLocation(location: LatLng)
getActivity @Nullable
fun getActivity(): FragmentActivity?
getAllowEnterTransitionOverlap open fun getAllowEnterTransitionOverlap(): Boolean
getAllowReturnTransitionOverlap open fun getAllowReturnTransitionOverlap(): Boolean
getArguments @Nullable
fun getArguments(): Bundle?
getChildFragmentManager @NonNull
fun getChildFragmentManager(): FragmentManager
getContext @Nullable
open fun getContext(): Context?
getContributor fun getContributor(): TripKitMapContributor?
getDefaultViewModelProviderFactory @NonNull
open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory
getEnterTransition @Nullable
open fun getEnterTransition(): Any?
getExitTransition @Nullable
open fun getExitTransition(): Any?
getHost @Nullable
fun getHost(): Any?
getId fun getId(): Int
getLayoutInflater @NonNull
fun getLayoutInflater(): LayoutInflater
getLifecycle @NonNull
open override fun getLifecycle(): Lifecycle
getMapAsync open fun getMapAsync(p0: OnMapReadyCallback)
getParentFragment @Nullable
fun getParentFragment(): Fragment?
getParentFragmentManager @NonNull
fun getParentFragmentManager(): FragmentManager
getReenterTransition @Nullable
open fun getReenterTransition(): Any?
getResources @NonNull
fun getResources(): Resources
getReturnTransition @Nullable
open fun getReturnTransition(): Any?
getSavedStateRegistry @NonNull
override fun getSavedStateRegistry(): SavedStateRegistry
getSharedElementEnterTransition @Nullable
open fun getSharedElementEnterTransition(): Any?
getSharedElementReturnTransition @Nullable
open fun getSharedElementReturnTransition(): Any?
getString @NonNull
fun getString(@StringResp0: Int): String
@NonNull
fun getString(@StringResp0: Int, @Nullablevararg p1: Any): String
getTag @Nullable
fun getTag(): String?
getText @NonNull
fun getText(@StringResp0: Int): CharSequence
getView @Nullable
open fun getView(): View?
getViewLifecycleOwner @MainThread
@NonNull
open fun getViewLifecycleOwner(): LifecycleOwner
getViewLifecycleOwnerLiveData @NonNull
open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>
getViewModelStore @NonNull
open override fun getViewModelStore(): ViewModelStore
hashCode override fun hashCode(): Int
hasOptionsMenu @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun hasOptionsMenu(): Boolean
isAdded fun isAdded(): Boolean
isDetached fun isDetached(): Boolean
isHidden fun isHidden(): Boolean
isInLayout fun isInLayout(): Boolean
isMenuVisible @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun isMenuVisible(): Boolean
isRemoving fun isRemoving(): Boolean
isResumed fun isResumed(): Boolean
isStateSaved fun isStateSaved(): Boolean
isVisible fun isVisible(): Boolean
moveCameraToPolygonBounds fun moveCameraToPolygonBounds(polygon: Polygon)
moveToCameraPosition fun moveToCameraPosition(cameraPosition: CameraPosition)
moveToLatLng fun moveToLatLng(latLng: LatLng)
observe fun <T : Any, L : LiveData<T>> LifecycleOwner.observe(liveData: L, body: (T?) -> Unit)
onActivityCreated open override fun onActivityCreated(p0: Bundle?)
onAttach open override fun onAttach(p0: Activity)
open override fun onAttach(context: Context)
onCameraChange open override fun onCameraChange(position: CameraPosition)
onCameraIdle open override fun onCameraIdle()
onConfigurationChanged @CallSuper
open override fun onConfigurationChanged(@NonNullp0: Configuration)
onContextItemSelected @MainThread
open fun onContextItemSelected(@NonNullp0: MenuItem): Boolean
onCreate open override fun onCreate(savedInstanceState: Bundle?)
onCreateAnimation @MainThread
@Nullable
open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?
onCreateAnimator @MainThread
@Nullable
open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?
onCreateContextMenu @MainThread
open override fun onCreateContextMenu(@NonNullp0: ContextMenu, @NonNullp1: View, @Nullablep2: ContextMenu.ContextMenuInfo?)
onCreateOptionsMenu @MainThread
open fun onCreateOptionsMenu(@NonNullp0: Menu, @NonNullp1: MenuInflater)
onCreateView open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View?
onDestroy open override fun onDestroy()
onDestroyOptionsMenu @MainThread
open fun onDestroyOptionsMenu()
onDestroyView open override fun onDestroyView()
onDetach @MainThread
@CallSuper
open fun onDetach()
onEnterAmbient fun onEnterAmbient(p0: Bundle)
onExitAmbient fun onExitAmbient()
onGetLayoutInflater @NonNull
open fun onGetLayoutInflater(@Nullablep0: Bundle?): LayoutInflater
onHiddenChanged @MainThread
open fun onHiddenChanged(p0: Boolean)
onInflate @UiThread
@CallSuper
open fun onInflate(@NonNullp0: Context, @NonNullp1: AttributeSet, @Nullablep2: Bundle?)
open override fun onInflate(p0: Activity, p1: AttributeSet, p2: Bundle?)
onInfoWindowClick open override fun onInfoWindowClick(marker: Marker)
onLowMemory open override fun onLowMemory()
onMapLongClick open override fun onMapLongClick(latLng: LatLng)
onMarkerClick open override fun onMarkerClick(marker: Marker): Boolean
onMultiWindowModeChanged open fun onMultiWindowModeChanged(p0: Boolean)
onOptionsItemSelected @MainThread
open fun onOptionsItemSelected(@NonNullp0: MenuItem): Boolean
onOptionsMenuClosed @MainThread
open fun onOptionsMenuClosed(@NonNullp0: Menu)
onPause open override fun onPause()
onPictureInPictureModeChanged open fun onPictureInPictureModeChanged(p0: Boolean)
onPoiClick open override fun onPoiClick(pointOfInterest: PointOfInterest)
onPrepareOptionsMenu @MainThread
open fun onPrepareOptionsMenu(@NonNullp0: Menu)
onPrimaryNavigationFragmentChanged @MainThread
open fun onPrimaryNavigationFragmentChanged(p0: Boolean)
onResume open override fun onResume()
onSaveInstanceState open override fun onSaveInstanceState(p0: Bundle)
onStart open override fun onStart()
onStop open override fun onStop()
onViewCreated open override fun onViewCreated(view: View, savedInstanceState: Bundle?)
onViewStateRestored @MainThread
@CallSuper
open fun onViewStateRestored(@Nullablep0: Bundle?)
popSpecificWithTag fun Fragment.popSpecificWithTag(tag: String)
postponeEnterTransition open fun postponeEnterTransition()
fun postponeEnterTransition(p0: Long, @NonNullp1: TimeUnit)
refreshMap fun refreshMap(map: GoogleMap)
registerForActivityResult @MainThread
@NonNull
override fun <I : Any, O : Any> registerForActivityResult(@NonNullp0: ActivityResultContract<I, O>, @NonNullp1: ActivityResultCallback<O>): ActivityResultLauncher<I>
@MainThread
@NonNull
override fun <I : Any, O : Any> registerForActivityResult(@NonNullp0: ActivityResultContract<I, O>, @NonNullp1: ActivityResultRegistry, @NonNullp2: ActivityResultCallback<O>): ActivityResultLauncher<I>
registerForContextMenu open fun registerForContextMenu(@NonNullp0: View)
removePinnedLocationMarker fun removePinnedLocationMarker(markers: List<Marker>? = null)
replaceFragment fun Fragment.replaceFragment(fragment: Fragment, tag: String, containerViewId: Int, checkBackStack: Boolean = true)
fun Fragment.replaceFragment(fragment: Fragment, tag: String, containerViewId: Int, checkBackStack: Boolean = true, addToBackStack: Boolean = true)
requireActivity @NonNull
fun requireActivity(): FragmentActivity
requireArguments @NonNull
fun requireArguments(): Bundle
requireContext @NonNull
fun requireContext(): Context
requireHost @NonNull
fun requireHost(): Any
requireParentFragment @NonNull
fun requireParentFragment(): Fragment
requireView @NonNull
fun requireView(): View
setAllowEnterTransitionOverlap open fun setAllowEnterTransitionOverlap(p0: Boolean)
setAllowReturnTransitionOverlap open fun setAllowReturnTransitionOverlap(p0: Boolean)
setArguments open override fun setArguments(p0: Bundle?)
setContributor fun setContributor(newContributor: TripKitMapContributor?)
setEnterSharedElementCallback open fun setEnterSharedElementCallback(@Nullablep0: SharedElementCallback?)
setEnterTransition open fun setEnterTransition(@Nullablep0: Any?)
setExitSharedElementCallback open fun setExitSharedElementCallback(@Nullablep0: SharedElementCallback?)
setExitTransition open fun setExitTransition(@Nullablep0: Any?)
setFromMarkerLocation fun setFromMarkerLocation(location: LatLng?)
setHasOptionsMenu open fun setHasOptionsMenu(p0: Boolean)
setInfoWindowAdapter fun setInfoWindowAdapter(infoWindowAdapter: GoogleMap.InfoWindowAdapter?)
If we do not specify our own implementation, GoogleMap will fall back to its default implementation for InfoWindowAdapter.
setInitialSavedState open fun setInitialSavedState(@Nullablep0: Fragment.SavedState?)
setMenuVisibility open fun setMenuVisibility(p0: Boolean)
setOnInfoWindowClickListener fun setOnInfoWindowClickListener(listener: TripKitMapFragment.OnInfoWindowClickListener?)
fun setOnInfoWindowClickListener(listener: (Location?) -> Unit)
setOnZoomLevelChangedListener fun setOnZoomLevelChangedListener(listener: TripKitMapFragment.OnZoomLevelChangedListener?)
fun setOnZoomLevelChangedListener(listener: (Float) -> Unit)
setReenterTransition open fun setReenterTransition(@Nullablep0: Any?)
setReturnTransition open fun setReturnTransition(@Nullablep0: Any?)
setSettingsButtonVisibility fun setSettingsButtonVisibility(show: Boolean)
setSettingsIconOnClickListener fun setSettingsIconOnClickListener(listener: View.OnClickListener?)
fun setSettingsIconOnClickListener(l: (View) -> Unit)
setSharedElementEnterTransition open fun setSharedElementEnterTransition(@Nullablep0: Any?)
setSharedElementReturnTransition open fun setSharedElementReturnTransition(@Nullablep0: Any?)
setShowPoiMarkers fun setShowPoiMarkers(show: Boolean, modes: List<TransportMode>?)
setToMarkerLocation fun setToMarkerLocation(location: LatLng?)
shouldShowRequestPermissionRationale open fun shouldShowRequestPermissionRationale(@NonNullp0: String): Boolean
startActivity open fun startActivity(p0: Intent)
open fun startActivity(p0: Intent, @Nullablep1: Bundle?)
startPostponedEnterTransition open fun startPostponedEnterTransition()
toString @NonNull
open override fun toString(): String
unregisterForContextMenu open fun unregisterForContextMenu(@NonNullp0: View)
updatePinForType fun updatePinForType()
whenSafeToUseMap fun whenSafeToUseMap(callback: Consumer<GoogleMap>)
A safer point to retrieve GoogleMap as the callback is invoked after fragment view is measured. This makes it safe to move or animate map with CameraUpdate.