diff --git a/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java b/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java index c790fdb6f..3673266a7 100644 --- a/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java +++ b/android/src/main/java/com/facebook/sonar/core/SonarStateUpdateListener.java @@ -2,6 +2,11 @@ package com.facebook.sonar.core; public interface SonarStateUpdateListener { + /** + * Called when the state of the sonar client changes. + * Typical implementations will subscribe by calling {@link com.facebook.sonar.core.SonarClient#subscribeForUpdates()}, to start receiving update events. + * Calling {@link com.facebook.sonar.core.SonarClient#getState()} will retrieve the updated state. + */ void onUpdate(); }