/*
 Copyright 2009-2014 Urban Airship Inc. All rights reserved.
 
 Redistribution and use in source and binary forms, with or 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 withthe distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE URBAN AIRSHIP INC``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 URBAN AIRSHIP INC 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.
 */

/** These are common keys used in several location classes */

/**
 * Represents the possible location provider status.
 */
typedef NS_ENUM(NSInteger, UALocationProviderStatus) {
    /**
     * The service is not updating location.
     */
    UALocationProviderNotUpdating,

    /**
     * The service is currently updating location.
     */
    UALocationProviderUpdating
};

/**
 * Represents the possible location service error conditions.
 */
typedef NS_ENUM(NSInteger, UALocationServiceError) {
    /**
     * The location service timed out before receiving a location.
     */
    UALocationServiceTimedOut
};

// The different service provider types, for UAAnalytics
typedef NSString UALocationServiceProviderType;
extern UALocationServiceProviderType * const UALocationServiceProviderGps;
extern UALocationServiceProviderType * const UALocationServiceProviderNetwork;
extern UALocationServiceProviderType * const UALocationServiceProviderUnknown;

// These are the keys for the stored UALocationService values in the NSUserDefaults
typedef NSString UALocationServiceNSDefaultsKey;
extern UALocationServiceNSDefaultsKey * const UALocationServiceAllowedKey;
extern UALocationServiceNSDefaultsKey * const UALocationServiceEnabledKey;
extern UALocationServiceNSDefaultsKey * const UAStandardLocationServiceRestartKey;
extern UALocationServiceNSDefaultsKey * const UASignificantChangeServiceRestartKey;
extern UALocationServiceNSDefaultsKey * const UAStandardLocationDistanceFilterKey;
extern UALocationServiceNSDefaultsKey * const UAStandardLocationDesiredAccuracyKey;
extern UALocationServiceNSDefaultsKey * const UASingleLocationDesiredAccuracyKey;
extern UALocationServiceNSDefaultsKey * const UASingleLocationTimeoutKey;

typedef NSString UALocationServiceErrorDomain;
extern UALocationServiceErrorDomain * const UALocationServiceTimeoutError;