FPRSessionManager.h 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. // Copyright 2020 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #import <Foundation/Foundation.h>
  15. #import "FirebasePerformance/Sources/AppActivity/FPRSessionDetails.h"
  16. /* Notification name when the session Id gets updated. */
  17. FOUNDATION_EXTERN NSString *_Nonnull const kFPRSessionIdUpdatedNotification;
  18. /** This class manages the current active sessionId of the application and provides mechanism for
  19. * propagating the session Id.
  20. */
  21. @interface FPRSessionManager : NSObject
  22. /** The current active session managed by the session manager. */
  23. @property(nonatomic, readonly, nonnull) FPRSessionDetails *sessionDetails;
  24. /**
  25. * The notification center managed by the session manager. All the notifications by the session
  26. * manager will get broadcasted on this notification center.
  27. */
  28. @property(nonatomic, readonly, nonnull) NSNotificationCenter *sessionNotificationCenter;
  29. /**
  30. * The shared instance of Session Manager.
  31. *
  32. * @return The singleton instance.
  33. */
  34. + (nonnull FPRSessionManager *)sharedInstance;
  35. - (nullable instancetype)init NS_UNAVAILABLE;
  36. /**
  37. * Starts tracking the application state changes to begin session ID state changes.
  38. */
  39. - (void)startTrackingAppStateChanges;
  40. @end