[ACR-723] add new API and error about User Consent
[platform/core/api/maps-service.git] / include / maps_error.h
1 /*
2  * Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __MAPS_ERROR_H__
18 #define __MAPS_ERROR_H__
19
20 #include <tizen_type.h>
21 #include <tizen_error.h>
22
23 /**
24  * @ingroup     CAPI_MAPS_SERVICE_MODULE
25  *
26  * @file maps_error.h
27  * @brief This file contains the list of errors of Maps API
28  *
29  * @addtogroup CAPI_MAPS_SERVICE_AND_PREFERENCE_MODULE
30  * @{
31  * @brief This provides a list of Maps API errors
32  */
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 #ifndef TIZEN_ERROR_MAPS_SERVICE
39 #define TIZEN_ERROR_MAPS_SERVICE        -0x02C20000
40 #endif
41
42 /**
43  * @brief Enumerations of error codes for Maps Service and Plug-ins
44  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
45  */
46 typedef enum _maps_error_e {
47         MAPS_ERROR_NONE = TIZEN_ERROR_NONE,     /**< Successful */
48
49         MAPS_ERROR_PERMISSION_DENIED =
50                 TIZEN_ERROR_PERMISSION_DENIED,  /**< Permission Denied */
51
52         MAPS_ERROR_OUT_OF_MEMORY =
53                 TIZEN_ERROR_OUT_OF_MEMORY,              /**< Out of memory */
54
55         MAPS_ERROR_INVALID_PARAMETER =
56                 TIZEN_ERROR_INVALID_PARAMETER,  /**< Invalid parameter */
57
58         MAPS_ERROR_NOT_SUPPORTED =
59                 TIZEN_ERROR_NOT_SUPPORTED,              /**< Not supported */
60
61         MAPS_ERROR_CONNECTION_TIME_OUT =
62                 TIZEN_ERROR_CONNECTION_TIME_OUT,/**< Timeout error, no answer */
63
64         MAPS_ERROR_NETWORK_UNREACHABLE =
65                 TIZEN_ERROR_NETWORK_UNREACHABLE,/**< Network unavailable*/
66
67         MAPS_ERROR_INVALID_OPERATION =
68                 TIZEN_ERROR_INVALID_OPERATION,  /**< Operation is not valid */
69
70         MAPS_ERROR_KEY_NOT_AVAILABLE =
71                 TIZEN_ERROR_KEY_NOT_AVAILABLE,  /**< Invalid key */
72
73         MAPS_ERROR_RESOURCE_BUSY =
74                 TIZEN_ERROR_RESOURCE_BUSY,              /**< Maps Service busy */
75
76         MAPS_ERROR_CANCELED =
77                 TIZEN_ERROR_CANCELED,                   /**< Maps Service request aborted */
78
79         MAPS_ERROR_UNKNOWN =
80                 TIZEN_ERROR_UNKNOWN,                    /**< Unknown error */
81
82         MAPS_ERROR_USER_NOT_CONSENTED =
83                 TIZEN_ERROR_USER_NOT_CONSENTED, /**< Not Consented (Since @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif) */
84
85         MAPS_ERROR_SERVICE_NOT_AVAILABLE =
86                 TIZEN_ERROR_MAPS_SERVICE | 0x01,/**< Service unavailable */
87
88         MAPS_ERROR_NOT_FOUND =
89                 TIZEN_ERROR_MAPS_SERVICE | 0x02 /**< Result not found */
90 } maps_error_e;
91
92 #ifdef __cplusplus
93 }
94 #endif
95 /**
96  * @}
97  */
98 #endif                          /* __MAPS_ERROR_H__ */