#1216 - Documenting use of pauseMetricsCollection and resumeMetricsCollection

1 files changed, 10 insertions, 0 deletions

diff --git a/ios/app/MBXAppDelegate.m b/ios/app/MBXAppDelegate.m
index 8c5947354a..75e02c9980 100644
--- a/ios/app/MBXAppDelegate.m
+++ b/ios/app/MBXAppDelegate.m
@@ -15,11 +15,21 @@
 
 - (void)applicationWillEnterForeground:(UIApplication *)application
 {
+    // Example of how to resume Metrics Collection
+    
+    // Reasons for needing to resume:
+    // 1. In UIBackground and app starts listening for Location Updates where it previously had not been listening.
+    // 2. App is entering foreground where it had called pauseMetricsCollection.
     [MGLMapboxEvents resumeMetricsCollection];
 }
 
 - (void)applicationDidEnterBackground:(UIApplication *)application
 {
+    // Example of how to pause Metrics Collection
+    
+    // Reason for needing to pause:
+    // 1. Either entering or already in UIBackground and app stops listening for Location Updates
+    // via any CLLocationManager instance it may have.
     [MGLMapboxEvents pauseMetricsCollection];
 }