ModemManager::ModemLocation Class

class ModemManager::ModemLocation

The ModemLocation class. More...

Header:	`#include <ModemManagerQt/ModemLocation>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS ModemManagerQt)` `target_link_libraries(mytarget PRIVATE KF6::ModemManagerQt)`
Inherits:	ModemManager::Interface

List of all members, including inherited members

Public Types

	List
	Ptr

Public Functions

	ModemLocation(const QString &path, QObject *parent = nullptr)
ModemManager::ModemLocation::LocationSources	capabilities() const
ModemManager::ModemLocation::LocationSources	enabledCapabilities() const
QDBusPendingReply<ModemManager::LocationInformationMap>	getLocation()
bool	isEnabled() const
ModemManager::LocationInformationMap	location() const
void	setTimeout(int timeout)
QDBusPendingReply<void>	setup(ModemManager::ModemLocation::LocationSources sources, bool signalLocation)
bool	signalsLocation() const
int	timeout() const

Signals

void	capabilitiesChanged(QFlags<MMModemLocationSource> capabilities)
void	enabledCapabilitiesChanged(QFlags<MMModemLocationSource> capabilities)
void	locationChanged(const ModemManager::LocationInformationMap &location)
void	signalsLocationChanged(bool signalsLocation)

Detailed Description

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.

Member Type Documentation

ModemLocation::List

ModemLocation::Ptr

Member Function Documentation

`[explicit]` ModemLocation::ModemLocation(const QString &path, QObject **parent* = nullptr)

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

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

`[signal]` void ModemLocation::capabilitiesChanged(QFlags<MMModemLocationSource> capabilities)

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

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

`[signal]` void ModemLocation::enabledCapabilitiesChanged(QFlags<MMModemLocationSource> capabilities)

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.

bool ModemLocation::isEnabled() const

Returns whether the device has any location capabilities

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.

`[signal]` void ModemLocation::locationChanged(const ModemManager::LocationInformationMap &location)

Emitted when the location has changed

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).

See also timeout().

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.

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.

`[signal]` void ModemLocation::signalsLocationChanged(bool signalsLocation)

int ModemLocation::timeout() const

Returns the current value of the DBus timeout in milliseconds. -1 means the default DBus timeout (usually 25 seconds).

See also setTimeout().

Contents