Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

[Android] Added Style object parameter mention to LocationComponent methods #13597

Merged
merged 1 commit into from
Dec 19, 2018
Merged

[Android] Added Style object parameter mention to LocationComponent methods #13597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ...oid/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/LocationComponent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ public LocationComponent(@NonNull MapboxMap mapboxMap) {
* <strong>Note</strong>: This method will initialize and use an internal {@link LocationEngine} when enabled.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
*/
@RequiresPermission(anyOf = {ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION})
public void activateLocationComponent(@NonNull Context context, @NonNull Style style) {
Expand All @@ -218,6 +219,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* Afterwards, you can manage component's visibility by {@link #setLocationComponentEnabled(boolean)}.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param useDefaultLocationEngine true if you want to initialize and use the built-in location engine or false if
* there should be no location engine initialized
*/
Expand All @@ -236,6 +238,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* Afterwards, you can manage component's visibility by {@link #setLocationComponentEnabled(boolean)}.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param useDefaultLocationEngine true if you want to initialize and use the built-in location engine or false if
* there should be no location engine initialized
* @param locationEngineRequest the location request
Expand All @@ -259,6 +262,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* <strong>Note</strong>: This method will initialize and use an internal {@link LocationEngine} when enabled.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param styleRes the LocationComponent style res
*/
@RequiresPermission(anyOf = {ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION})
Expand All @@ -274,6 +278,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* </p>
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param options the options
*/
@RequiresPermission(anyOf = {ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION})
Expand All @@ -289,6 +294,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* Afterwards, you can manage component's visibility by {@link #setLocationComponentEnabled(boolean)}.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param locationEngine the engine, or null if you'd like to only force location updates
* @param styleRes the LocationComponent style res
*/
Expand All @@ -304,6 +310,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* Afterwards, you can manage component's visibility by {@link #setLocationComponentEnabled(boolean)}.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param locationEngine the engine, or null if you'd like to only force location updates
* @param locationEngineRequest the location request
* @param styleRes the LocationComponent style res
Expand All @@ -320,6 +327,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* This method will show the location icon and enable the camera tracking the location.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param locationEngine the engine
*/
@RequiresPermission(anyOf = {ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION})
Expand All @@ -332,6 +340,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* This method will show the location icon and enable the camera tracking the location.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param locationEngine the engine
* @param locationEngineRequest the location request
*/
Expand All @@ -347,6 +356,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* Afterwards, you can manage component's visibility by {@link #setLocationComponentEnabled(boolean)}.
*
* @param locationEngine the engine, or null if you'd like to only force location updates
* @param style the proxy object for current map style. More info at {@link Style}
* @param options the options
*/
@RequiresPermission(anyOf = {ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION})
Expand All @@ -363,6 +373,7 @@ public void activateLocationComponent(@NonNull Context context, @NonNull Style s
* Afterwards, you can manage component's visibility by {@link #setLocationComponentEnabled(boolean)}.
*
* @param context the context
* @param style the proxy object for current map style. More info at {@link Style}
* @param locationEngine the engine, or null if you'd like to only force location updates
* @param locationEngineRequest the location request
* @param options the options
Expand Down