Skip to content

Commit 438bb87

Browse files
persidskiygithub-actions[bot]
authored andcommitted
Update viewport doc (#3568)
https://mapbox.atlassian.net/browse/MAPSIOS-1798 Users tend to directly call methods that are not indended for that cc @mapbox/sdk-ci GitOrigin-RevId: 292073e79d0c58d133e4fb5ed16737224ab0a406
1 parent f107d48 commit 438bb87

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

sdk-base/src/main/java/com/mapbox/maps/plugin/viewport/state/ViewportState.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ interface ViewportState {
5555
* Indicates the current [ViewportState] is now responsible for updating the camera.
5656
*
5757
* [ViewportPlugin] calls this method at the end of a successful transition into this state.
58+
*
59+
* @warning Don't call this method directly, instead activate the viewport via [ViewportPlugin.transitionTo].
5860
*/
5961
fun startUpdatingCamera()
6062

@@ -65,6 +67,8 @@ interface ViewportState {
6567
*
6668
* Implementations must stop updating the camera immediately and should typically cancel any ongoing
6769
* animations that they started when this method is invoked.
70+
*
71+
* @warning Don't call this method directly. Instead, use [ViewportPlugin.idle] to stop animations in progress.
6872
*/
6973
fun stopUpdatingCamera()
7074
}

0 commit comments

Comments
 (0)