Ubuntu Platform API  3.0.0
A library helping with tight integration into the Ubuntu platform
service.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  */
18 
19 #ifndef UBUNTU_APPLICATION_LOCATION_SERVICE_H_
20 #define UBUNTU_APPLICATION_LOCATION_SERVICE_H_
21 
22 #include <ubuntu/visibility.h>
23 
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
56  typedef enum
57  {
62 
64 
69  typedef unsigned int UALocationServiceRequirementsFlags;
70 
75  typedef enum
76  {
82 
84 
96 
109  UALocationServiceError* status);
110 
122 
135  UALocationServiceError* status);
136 
145 
146 #ifdef __cplusplus
147 }
148 #endif
149 
150 #endif // UBUNTU_APPLICATION_LOCATION_SERVICE_H_
UA_LOCATION_SERVICE_ERROR_GENERIC_ERROR
@ UA_LOCATION_SERVICE_ERROR_GENERIC_ERROR
Definition: service.h:80
ua_location_service_create_session_for_low_accuracy
UBUNTU_DLL_PUBLIC UALocationServiceSession * ua_location_service_create_session_for_low_accuracy(UALocationServiceRequirementsFlags flags)
Creates a new session with the location service for low positional accuracy requirements.
ua_location_service_try_create_session_for_low_accuracy
UBUNTU_DLL_PUBLIC UALocationServiceSession * ua_location_service_try_create_session_for_low_accuracy(UALocationServiceRequirementsFlags flags, UALocationServiceError *status)
Tries to reate a new session with the location service for low positional accuracy requirements.
ua_location_service_create_session_for_high_accuracy
UBUNTU_DLL_PUBLIC UALocationServiceSession * ua_location_service_create_session_for_high_accuracy(UALocationServiceRequirementsFlags flags)
Creates a new session with the location service for high positional accuracy requirements.
UbuntuApplicationLocationServiceError
UbuntuApplicationLocationServiceError
Possible error codes reported when trying to create a session.
Definition: service.h:75
UA_LOCATION_SERVICE_REQUIRE_HEADING
@ UA_LOCATION_SERVICE_REQUIRE_HEADING
Definition: service.h:59
UALocationServiceRequirement
UbuntuApplicationLocationServiceRequirement UALocationServiceRequirement
Definition: service.h:63
visibility.h
session.h
controller.h
UALocationServiceError
UbuntuApplicationLocationServiceError UALocationServiceError
Definition: service.h:83
UbuntuApplicationLocationServiceRequirement
UbuntuApplicationLocationServiceRequirement
Application-specific requirements.
Definition: service.h:56
UA_LOCATION_SERVICE_ERROR_NO_CONNECTION
@ UA_LOCATION_SERVICE_ERROR_NO_CONNECTION
Definition: service.h:78
UBUNTU_DLL_PUBLIC
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
UA_LOCATION_SERVICE_REQUIRE_VELOCITY
@ UA_LOCATION_SERVICE_REQUIRE_VELOCITY
Definition: service.h:60
ua_location_service_try_create_session_for_high_accuracy
UBUNTU_DLL_PUBLIC UALocationServiceSession * ua_location_service_try_create_session_for_high_accuracy(UALocationServiceRequirementsFlags flags, UALocationServiceError *status)
Tries to reate a new session with the location service for high positional accuracy requirements.
ua_location_service_create_controller
UBUNTU_DLL_PUBLIC UALocationServiceController * ua_location_service_create_controller()
Creates a new controller for the location service.
UALocationServiceSession
struct UbuntuApplicationLocationServiceSession UALocationServiceSession
Opaque type encapsulating a session with the location service.
Definition: session.h:38
UA_LOCATION_SERVICE_ERROR_NO_ACCESS
@ UA_LOCATION_SERVICE_ERROR_NO_ACCESS
Definition: service.h:79
UA_LOCATION_SERVICE_REQUIRE_ALTITUDE
@ UA_LOCATION_SERVICE_REQUIRE_ALTITUDE
Definition: service.h:58
UALocationServiceRequirementsFlags
unsigned int UALocationServiceRequirementsFlags
Bitfield type for summarizing an application's requirements.
Definition: service.h:69
UALocationServiceController
struct UbuntuApplicationLocationServiceController UALocationServiceController
Opaque type encapsulating a controller the location service.
Definition: controller.h:58
UA_LOCATION_SERVICE_ERROR_NONE
@ UA_LOCATION_SERVICE_ERROR_NONE
Definition: service.h:77