MBXLiveTrackingClient_Internal.h 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxCommon/MBXLiveTrackingState.h>
  4. #import <MapboxCommon/MBXLocationClientStartStopCallback.h>
  5. @protocol MBXLiveTrackingClientObserver;
  6. NS_SWIFT_NAME(LiveTrackingClient)
  7. @protocol MBXLiveTrackingClient
  8. /**
  9. * Starts location tracking.
  10. *
  11. * @param settings Settings for this instance of the client.
  12. * When settings are not specified then reasonable default will be applied.
  13. * Unknown values in settings should be omitted by implementation silently.
  14. * @param callback Callback to get notified about the result of the call.
  15. *
  16. */
  17. - (void)startForSettings:(nullable id)settings
  18. callback:(nonnull MBXLocationClientStartStopCallback)callback;
  19. /**
  20. * Stops location tracking.
  21. *
  22. * @param callback Callback to get notified about the result of the call.
  23. */
  24. - (void)stopForCallback:(nonnull MBXLocationClientStartStopCallback)callback;
  25. - (void)registerObserverForObserver:(nonnull id<MBXLiveTrackingClientObserver>)observer;
  26. - (void)unregisterObserverForObserver:(nonnull id<MBXLiveTrackingClientObserver>)observer;
  27. /** Gets the name of this live tracking client implementation. */
  28. - (nonnull NSString *)getName;
  29. /** Gets current state of a client. */
  30. - (MBXLiveTrackingState)getState;
  31. /**
  32. * Gets settings in action.
  33. *
  34. * @return Returns employed setting or
  35. * nothing if it's called before the start.
  36. * See LiveTrackingClientSettings.
  37. */
  38. - (nullable id)getActiveSettings;
  39. /** Asks the client to flush batched locations to listeners. */
  40. - (void)flush;
  41. @end