ModemManager::ModemLocation

#include <modemlocation.h>

Inherits ModemManager::Interface.

Public Types
typedef QList< Ptr >	List

typedef QFlags< MMModemLocationSource >	LocationSources

typedef QSharedPointer< ModemLocation >	Ptr

Signals
void	capabilitiesChanged (QFlags< MMModemLocationSource > capabilities)

void	enabledCapabilitiesChanged (QFlags< MMModemLocationSource > capabilities)

void	locationChanged (const ModemManager::LocationInformationMap &location)

void	signalsLocationChanged (bool signalsLocation)

Public Member Functions
	ModemLocation (const QString &path, QObject *parent=nullptr)

LocationSources	capabilities () const

LocationSources	enabledCapabilities () const

QDBusPendingReply< LocationInformationMap >	getLocation ()

bool	isEnabled () const

LocationInformationMap	location () const

void	setTimeout (int timeout)

QDBusPendingReply< void >	setup (ModemManager::ModemLocation::LocationSources sources, bool signalLocation)

bool	signalsLocation () const

int	timeout () const

Detailed Description

The ModemLocation class.

The Location class allows devices to provide location information to client applications. Not all devices can provide this information, or even if they do, they may not be able to provide it while a data session is active.

Definition at line 33 of file modemlocation.h.

Member Typedef Documentation

◆ List

typedef QList<Ptr> ModemManager::ModemLocation::List

Definition at line 41 of file modemlocation.h.

◆ LocationSources

typedef QFlags< MMModemLocationSource > ModemManager::ModemLocation::LocationSources

Definition at line 43 of file modemlocation.h.

◆ Ptr

typedef QSharedPointer<ModemLocation> ModemManager::ModemLocation::Ptr

Definition at line 40 of file modemlocation.h.

Constructor & Destructor Documentation

◆ ModemLocation()

ModemLocation::ModemLocation	(	const QString &	path,
		QObject *	parent = nullptr )

explicit

Definition at line 36 of file modemlocation.cpp.

◆ ~ModemLocation()

ModemLocation::~ModemLocation ( )

override

Definition at line 60 of file modemlocation.cpp.

Member Function Documentation

◆ capabilities()

ModemManager::ModemLocation::LocationSources ModemLocation::capabilities ( ) const

Returns: QFlags of MMModemLocationSource values, specifying the supported location sources.

Definition at line 76 of file modemlocation.cpp.

◆ enabledCapabilities()

ModemManager::ModemLocation::LocationSources ModemLocation::enabledCapabilities ( ) const

Returns: QFlags specifying which of the supported MMModemLocationSource location sources is currently enabled in the device.

Definition at line 82 of file modemlocation.cpp.

◆ getLocation()

QDBusPendingReply< ModemManager::LocationInformationMap > ModemLocation::getLocation ( )

Returns: current location information, if any. If the modem supports multiple location types it may return more than one. See the "Location" property for more information on the dictionary returned at location.

This method may require the client to authenticate itself.

Definition at line 70 of file modemlocation.cpp.

◆ isEnabled()

bool ModemLocation::isEnabled ( ) const

Returns: whether the device has any location capabilities

Definition at line 88 of file modemlocation.cpp.

◆ location()

ModemManager::LocationInformationMap ModemLocation::location ( ) const

Returns: Dictionary of available location information when location information gathering is enabled. If the modem supports multiple location types it may return more than one here. Note that if the device was told not to emit updated location information when location information gathering was initially enabled, this property may not return any location information for security reasons.

Definition at line 100 of file modemlocation.cpp.

◆ locationChanged

void ModemManager::ModemLocation::locationChanged ( const ModemManager::LocationInformationMap & location )

signal

Emitted when the location has changed.

◆ setTimeout()

void ModemLocation::setTimeout ( int timeout )

Sets the timeout in milliseconds for all async method DBus calls.

-1 means the default DBus timeout (usually 25 seconds).

Definition at line 106 of file modemlocation.cpp.

◆ setup()

QDBusPendingReply< void > ModemLocation::setup	(	ModemManager::ModemLocation::LocationSources	sources,
		bool	signalLocation )

Configure the location sources to use when gathering location information.

Also enable or disable location information gathering. This method may require the client to authenticate itself.

When signals are emitted, any client application (including malicious ones!) can listen for location updates unless D-Bus permissions restrict these signals from certain users. If further security is desired, the signLocation argument can be set to FALSE to disable location updates via the locationChanged() signal and require applications to call authenticated APIs (like GetLocation() ) to get location information.

Definition at line 64 of file modemlocation.cpp.

◆ signalsLocation()

bool ModemLocation::signalsLocation ( ) const

Returns: TRUE if location updates will be emitted via the locationChanged() signal, FALSE if location updates will not be emitted.

See the setup() method for more information.

Definition at line 94 of file modemlocation.cpp.

◆ timeout()

int ModemLocation::timeout ( ) const

Returns the current value of the DBus timeout in milliseconds.