|  |  |  | libmm-glib Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
struct MMModemLocation; #define MM_LOCATION_LONGITUDE_UNKNOWN #define MM_LOCATION_LATITUDE_UNKNOWN #define MM_LOCATION_ALTITUDE_UNKNOWN const gchar * mm_modem_location_get_path (MMModemLocation *self); gchar * mm_modem_location_dup_path (MMModemLocation *self); MMModemLocationSource mm_modem_location_get_capabilities (MMModemLocation *self); MMModemLocationSource mm_modem_location_get_enabled (MMModemLocation *self); gboolean mm_modem_location_signals_location (MMModemLocation *self); void mm_modem_location_setup (MMModemLocation *self,MMModemLocationSource sources,gboolean signal_location,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean mm_modem_location_setup_finish (MMModemLocation *self,GAsyncResult *res,GError **error); gboolean mm_modem_location_setup_sync (MMModemLocation *self,MMModemLocationSource sources,gboolean signal_location,GCancellable *cancellable,GError **error); void mm_modem_location_get_3gpp (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); MMLocation3gpp * mm_modem_location_get_3gpp_finish (MMModemLocation *self,GAsyncResult *res,GError **error); MMLocation3gpp * mm_modem_location_get_3gpp_sync (MMModemLocation *self,GCancellable *cancellable,GError **error); void mm_modem_location_get_gps_nmea (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); MMLocationGpsNmea * mm_modem_location_get_gps_nmea_finish (MMModemLocation *self,GAsyncResult *res,GError **error); MMLocationGpsNmea * mm_modem_location_get_gps_nmea_sync (MMModemLocation *self,GCancellable *cancellable,GError **error); void mm_modem_location_get_gps_raw (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); MMLocationGpsRaw * mm_modem_location_get_gps_raw_finish (MMModemLocation *self,GAsyncResult *res,GError **error); MMLocationGpsRaw * mm_modem_location_get_gps_raw_sync (MMModemLocation *self,GCancellable *cancellable,GError **error); void mm_modem_location_get_cdma_bs (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); MMLocationCdmaBs * mm_modem_location_get_cdma_bs_finish (MMModemLocation *self,GAsyncResult *res,GError **error); MMLocationCdmaBs * mm_modem_location_get_cdma_bs_sync (MMModemLocation *self,GCancellable *cancellable,GError **error); void mm_modem_location_get_full (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean mm_modem_location_get_full_finish (MMModemLocation *self,GAsyncResult *res,MMLocation3gpp **location_3gpp,MMLocationGpsNmea **location_gps_nmea,MMLocationGpsRaw **location_gps_raw,MMLocationCdmaBs **location_cdma_bs,GError **error); gboolean mm_modem_location_get_full_sync (MMModemLocation *self,MMLocation3gpp **location_3gpp,MMLocationGpsNmea **location_gps_nmea,MMLocationGpsRaw **location_gps_raw,MMLocationCdmaBs **location_cdma_bs,GCancellable *cancellable,GError **error);
MMModemLocation implements GDBusInterface, GInitable, GAsyncInitable and MmGdbusModemLocation.
The MMModemLocation is an object providing access to the methods, signals and properties of the Location interface.
The Location interface is exposed whenever a modem has location capabilities.
struct MMModemLocation;
The MMModemLocation structure contains private data and should only be accessed using the provided API.
#define MM_LOCATION_LONGITUDE_UNKNOWN G_MINDOUBLE
Identifier for an unknown longitude value.
Proper longitude values fall in the [-180,180] range.
#define MM_LOCATION_LATITUDE_UNKNOWN G_MINDOUBLE
Identifier for an unknown latitude value.
Proper latitude values fall in the [-90,90] range.
#define MM_LOCATION_ALTITUDE_UNKNOWN G_MINDOUBLE
Identifier for an unknown altitude value.
const gchar *       mm_modem_location_get_path          (MMModemLocation *self);
Gets the DBus path of the MMObject which implements this interface.
| 
 | A MMModemLocation. | 
| Returns : | The DBus path of the MMObject object. [transfer none] | 
gchar *             mm_modem_location_dup_path          (MMModemLocation *self);
Gets a copy of the DBus path of the MMObject object which implements this interface.
| 
 | A MMModemLocation. | 
| Returns : | The DBus path of the MMObject. The returned value should be freed with g_free(). [transfer full] | 
MMModemLocationSource mm_modem_location_get_capabilities
                                                        (MMModemLocation *self);
Gets a bitmask of the location capabilities which are enabled in this MMModemLocation.
| 
 | A MMModemLocation. | 
| Returns : | A MMModemLocationSource. | 
MMModemLocationSource mm_modem_location_get_enabled     (MMModemLocation *self);
gboolean            mm_modem_location_signals_location  (MMModemLocation *self);
Gets the status of the location signaling in the MMModemLocation.
| 
 | A MMModemLocation. | 
| Returns : | TRUEif location changes are signaled,FALSEotherwise.. | 
void mm_modem_location_setup (MMModemLocation *self,MMModemLocationSource sources,gboolean signal_location,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously configures the location sources to use when gathering location information. Also enable or disable location information gathering.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call mm_modem_location_setup_finish() to get the result of the operation.
See mm_modem_location_setup_sync() for the synchronous, blocking version of this method.
| 
 | A MMModemLocation. | 
| 
 | Bitmask of MMModemLocationSource values specifying which locations should get enabled. | 
| 
 | Flag to enable or disable location signaling. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
gboolean mm_modem_location_setup_finish (MMModemLocation *self,GAsyncResult *res,GError **error);
Finishes an operation started with mm_modem_location_setup().
| 
 | A MMModemLocation. | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_modem_location_setup(). | 
| 
 | Return location for error or NULL. | 
| Returns : | TRUEif the setup was successful,FALSEiferroris set. | 
gboolean mm_modem_location_setup_sync (MMModemLocation *self,MMModemLocationSource sources,gboolean signal_location,GCancellable *cancellable,GError **error);
Synchronously configures the location sources to use when gathering location information. Also enable or disable location information gathering.
The calling thread is blocked until a reply is received. See mm_modem_location_setup()
for the asynchronous version of this method.
| 
 | A MMModemLocation. | 
| 
 | Bitmask of MMModemLocationSource values specifying which locations should get enabled. | 
| 
 | Flag to enable or disable location signaling. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | TRUEif the setup was successful,FALSEiferroris set. | 
void mm_modem_location_get_3gpp (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously gets the current 3GPP location information.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call mm_modem_location_get_3gpp_finish() to get the result of the operation.
See mm_modem_location_get_3gpp_sync() for the synchronous, blocking version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
MMLocation3gpp * mm_modem_location_get_3gpp_finish (MMModemLocation *self,GAsyncResult *res,GError **error);
Finishes an operation started with mm_modem_location_get_3gpp().
| 
 | A MMModemLocation. | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_modem_location_get_3gpp(). | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocation3gpp, or NULL if not available. The returned value should be freed with g_object_unref(). | 
MMLocation3gpp * mm_modem_location_get_3gpp_sync (MMModemLocation *self,GCancellable *cancellable,GError **error);
Synchronously gets the current 3GPP location information.
The calling thread is blocked until a reply is received. See mm_modem_location_get_3gpp()
for the asynchronous version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocation3gpp, or NULL if not available. The returned value should be freed with g_object_unref(). | 
void mm_modem_location_get_gps_nmea (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously gets the current GPS NMEA location information.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call mm_modem_location_get_gps_nmea_finish() to get the result of the operation.
See mm_modem_location_get_gps_nmea_sync() for the synchronous, blocking version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
MMLocationGpsNmea * mm_modem_location_get_gps_nmea_finish (MMModemLocation *self,GAsyncResult *res,GError **error);
Finishes an operation started with mm_modem_location_get_gps_nmea().
| 
 | A MMModemLocation. | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_modem_location_get_gps_nmea(). | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocationGpsNmea, or NULL if not available. The returned value should be freed with g_object_unref(). | 
MMLocationGpsNmea * mm_modem_location_get_gps_nmea_sync (MMModemLocation *self,GCancellable *cancellable,GError **error);
Synchronously gets the current GPS NMEA location information.
The calling thread is blocked until a reply is received. See mm_modem_location_get_gps_nmea()
for the asynchronous version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocationGpsNmea, or NULL if not available. The returned value should be freed with g_object_unref(). | 
void mm_modem_location_get_gps_raw (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously gets the current GPS raw location information.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call mm_modem_location_get_gps_raw_finish() to get the result of the operation.
See mm_modem_location_get_gps_raw_sync() for the synchronous, blocking version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
MMLocationGpsRaw * mm_modem_location_get_gps_raw_finish (MMModemLocation *self,GAsyncResult *res,GError **error);
Finishes an operation started with mm_modem_location_get_gps_raw().
| 
 | A MMModemLocation. | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_modem_location_get_gps_raw(). | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocationGpsRaw, or NULL if not available. The returned value should be freed with g_object_unref(). | 
MMLocationGpsRaw * mm_modem_location_get_gps_raw_sync (MMModemLocation *self,GCancellable *cancellable,GError **error);
Synchronously gets the current GPS raw location information.
The calling thread is blocked until a reply is received. See mm_modem_location_get_gps_raw()
for the asynchronous version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocationGpsRaw, or NULL if not available. The returned value should be freed with g_object_unref(). | 
void mm_modem_location_get_cdma_bs (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously gets the current CDMA base station location information.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call mm_modem_location_get_cdma_bs_finish() to get the result of the operation.
See mm_modem_location_get_cdma_bs_sync() for the synchronous, blocking version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
MMLocationCdmaBs * mm_modem_location_get_cdma_bs_finish (MMModemLocation *self,GAsyncResult *res,GError **error);
Finishes an operation started with mm_modem_location_get_cdma_bs().
| 
 | A MMModemLocation. | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_modem_location_get_cdma_bs(). | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocationCdmaBs, or NULL if not available. The returned value should be freed with g_object_unref(). | 
MMLocationCdmaBs * mm_modem_location_get_cdma_bs_sync (MMModemLocation *self,GCancellable *cancellable,GError **error);
Synchronously gets the current CDMA base station location information.
The calling thread is blocked until a reply is received. See mm_modem_location_get_cdma_bs()
for the asynchronous version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | (transfer full) A MMLocationCdmaBs, or NULL if not available. The returned value should be freed with g_object_unref(). | 
void mm_modem_location_get_full (MMModemLocation *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously gets the current location information.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call mm_modem_location_get_full_finish() to get the result of the operation.
See mm_modem_location_get_full_sync() for the synchronous, blocking version of this method.
| 
 | A MMModemLocation. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
gboolean mm_modem_location_get_full_finish (MMModemLocation *self,GAsyncResult *res,MMLocation3gpp **location_3gpp,MMLocationGpsNmea **location_gps_nmea,MMLocationGpsRaw **location_gps_raw,MMLocationCdmaBs **location_cdma_bs,GError **error);
Finishes an operation started with mm_modem_location_get_full().
| 
 | A MMModemLocation. | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_modem_location_get_full(). | 
| 
 | Return location for a MMLocation3gpp if 3GPP location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for a MMLocationGpsNmea if GPS NMEA location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for a MMLocationGpsRaw if GPS raw location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for a MMLocationCdmaBs if CDMA Base Station location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for error or NULL. | 
| Returns : | TRUEif the retrieval was successful,FALSEiferroris set. | 
gboolean mm_modem_location_get_full_sync (MMModemLocation *self,MMLocation3gpp **location_3gpp,MMLocationGpsNmea **location_gps_nmea,MMLocationGpsRaw **location_gps_raw,MMLocationCdmaBs **location_cdma_bs,GCancellable *cancellable,GError **error);
Synchronously gets the current location information.
The calling thread is blocked until a reply is received. See mm_modem_location_get_full()
for the asynchronous version of this method.
| 
 | A MMModemLocation. | 
| 
 | Return location for a MMLocation3gpp if 3GPP location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for a MMLocationGpsNmea if GPS NMEA location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for a MMLocationGpsRaw if GPS raw location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | Return location for a MMLocationCdmaBs if CDMA Base Station location is requested, or NULL if not required. The returned value should be freed with g_object_unref(). [out][allow-none][transfer full] | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | TRUEif the setup was successful,FALSEiferroris set. |