/*
 Copyright 2010-2016 Warply Inc. All rights reserved.
 
 Redistribution and use in source and binary forms, without modification,
 are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.
 
 2. Redistributions in binaryform must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE WARPLY LTD ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 EVENT SHALL WARPLY LTD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*!
 @header WLLocationManager.h
 The Location Manager provides a functional interface to the Core Location.
 Use the methods declared here to start and stop report location manually or
 automatically during app lifecycle.
 @copyright Warply Inc.
 */

#import <Foundation/Foundation.h>
#import <CoreLocation/CoreLocation.h>

@protocol WLLocationManagerDelegate;

/*!
 @typedef WLLocationForegroundMode
 @abstract The modes of location monitoring. These correspond to the modes of the CLLocationManager.
 @field WLLocationForegroundModeOff The application does not send the server it's location.
 @field WLLocationForegroundModeSignificant The application sends the device's location only on significant location changes.
 @field WLLocationForegroundModeStandard The application sends the device's location at times/distances defined by the corresponding parameters.
 */
typedef enum WLLocationForegroundMode : unsigned int{
    WLLocationModeOff = 0,
    WLLocationModeSignificant,
    WLLocationModeStandard
}WLLocationForegroundMode;

/*!
 @class WLLocationManager
 @discussion This manager handles the geo-location functionality of Warply service.
 */
@interface WLLocationManager : NSObject <CLLocationManagerDelegate>

/*!
 @property locationManager
 @abstract A CLLocationManager.
 */
@property (nonatomic, strong) CLLocationManager *locationManager;

/*!
 @property locationManagerDelegate
 @abstract The locationManager's delegate.
 */
@property (nonatomic, weak) NSObject <WLLocationManagerDelegate>*locationManagerDelegate;

/*!
 @property foregroundMode
 @abstract The mode of location monitoring while the app is on the foreground.
 */
@property (nonatomic) WLLocationForegroundMode foregroundMode;

/*!
 @property backgroundMode
 @abstract The mode of location monitoring while the app is on the background or not running.
 */
@property (nonatomic) WLLocationForegroundMode backgroundMode;

/*!
 @property geofencingEnabled
 @abstract A flag that defines if ios geofencing is being used (in conjunction with backgroundMode and/or foregroundMode) in order to provide user location tracking.
 */
@property (nonatomic) BOOL geofencingEnabled;

/*!
 @methodgroup Purpose of Location Manager
 */
/*!
 This method returns a string which is the Location Manager purpose.
 @return Returns location manager purpose.
 */
- (NSString *)purpose;
/*!
 This method sets Location Manager purpose.
 @param purpose A string object with purpose of Location Manager.
 */
- (void)setPurpose:(NSString*)purpose;

/*!
 @methodgroup Managing Location Reporting
 */

/*!
 @methodgroup Managing AppLifecycle Location Reporting
 @description These methods are called during the AppLifecycle.
 */

/*!
 This method starts location reporting. It is called when application becomes
 active.
 */
- (void)applicationDidBecomeActive;

- (void)sendLocation:(CLLocation *)location;

/*!
 This method stops location reporting. It is called when application enters
 background.
 */
- (void)applicationDidEnterBackground;

@end

@protocol WLLocationManagerDelegate <NSObject>

- (void)locationManager:(CLLocationManager *)manager
    didUpdateToLocation:(CLLocation *)newLocation
           fromLocation:(CLLocation *)oldLocation;

- (void)locationManager:(CLLocationManager *)manager didEnterRegion:(CLRegion *)region;

@end