Tp::Client::ConnectionInterfaceLocationInterface Class Reference [Connection proxies]

#include <TelepathyQt4/Connection>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

• QDBusPendingReply
  < Tp::ContactLocations > GetLocations (const Tp::UIntList &contacts)
• QDBusPendingReply< QVariantMap > RequestLocation (uint contact)
• QDBusPendingReply SetLocation (const QVariantMap &location)

Signals

• void LocationUpdated (uint contact, const QVariantMap &location)

Public Member Functions

• ConnectionInterfaceLocationInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• ConnectionInterfaceLocationInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• ConnectionInterfaceLocationInterface (Tp::DBusProxy *proxy)
• ConnectionInterfaceLocationInterface (const Tp::Client::ConnectionInterface &mainInterface)
• ConnectionInterfaceLocationInterface (const Tp::Client::ConnectionInterface &mainInterface, QObject *parent)
• TELEPATHY_QT4_DEPRECATED
  Tp::UIntList LocationAccessControlTypes () const
• Tp::PendingVariant * requestPropertyLocationAccessControlTypes () const
• TELEPATHY_QT4_DEPRECATED
  Tp::RichPresenceAccessControl LocationAccessControl () const
• Tp::PendingVariant * requestPropertyLocationAccessControl () const
• TELEPATHY_QT4_DEPRECATED void setLocationAccessControl (const Tp::RichPresenceAccessControl &newValue)
• Tp::PendingOperation * setPropertyLocationAccessControl (Tp::RichPresenceAccessControl newValue)
• TELEPATHY_QT4_DEPRECATED uint SupportedLocationFeatures () const
• Tp::PendingVariant * requestPropertySupportedLocationFeatures () const
• Tp::PendingVariantMap * requestAllProperties () const

Static Public Member Functions

• static const char * staticInterfaceName ()

Protected Member Functions

• virtual void invalidate (Tp::DBusProxy *, const QString &, const QString &)

Properties

• Tp::UIntList LocationAccessControlTypes
• Tp::RichPresenceAccessControl LocationAccessControl
• uint SupportedLocationFeatures

---

Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Location."

---

Constructor & Destructor Documentation

Tp::Client::ConnectionInterfaceLocationInterface::ConnectionInterfaceLocationInterface	(	const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ConnectionInterfaceLocationInterface associated with the given object on the session bus.

Parameters:

	busName	Name of the service the object is on.
	objectPath	Path to the object on the service.
	parent	Passed to the parent class constructor.

Tp::Client::ConnectionInterfaceLocationInterface::ConnectionInterfaceLocationInterface	(	const QDBusConnection &	connection,
		const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ConnectionInterfaceLocationInterface associated with the given object on the given bus.

Parameters:

	connection	The bus via which the object can be reached.
	busName	Name of the service the object is on.
	objectPath	Path to the object on the service.
	parent	Passed to the parent class constructor.

Tp::Client::ConnectionInterfaceLocationInterface::ConnectionInterfaceLocationInterface

(

Tp::DBusProxy *

proxy

)

Creates a ConnectionInterfaceLocationInterface associated with the same object as the given proxy.

Parameters:

proxy

The proxy to use. It will also be the QObject::parent() for this object.

Tp::Client::ConnectionInterfaceLocationInterface::ConnectionInterfaceLocationInterface

(

const Tp::Client::ConnectionInterface &

mainInterface

)

[explicit]

Creates a ConnectionInterfaceLocationInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.

Parameters:

mainInterface

The proxy to use.

Tp::Client::ConnectionInterfaceLocationInterface::ConnectionInterfaceLocationInterface	(	const Tp::Client::ConnectionInterface &	mainInterface,
		QObject *	parent
	)

Creates a ConnectionInterfaceLocationInterface associated with the same object as the given proxy. However, a different parent object can be specified.

Parameters:

	mainInterface	The proxy to use.
	parent	Passed to the parent class constructor.

---

Member Function Documentation

static const char* Tp::Client::ConnectionInterfaceLocationInterface::staticInterfaceName

(

)

[inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Location", which this class represents.

Returns:

The D-Bus interface name.

TELEPATHY_QT4_DEPRECATED Tp::UIntList Tp::Client::ConnectionInterfaceLocationInterface::LocationAccessControlTypes

(

)

const [inline]

Getter for the remote object property "LocationAccessControlTypes".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyLocationAccessControlTypes() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ConnectionInterfaceLocationInterface::requestPropertyLocationAccessControlTypes

(

)

const [inline]

Asynchronous getter for the remote object property "LocationAccessControlTypes" of type Tp::UIntList.

The types of access control that are supported by this connection.

Returns:

A pending variant which will emit finished when the property has been retrieved.

TELEPATHY_QT4_DEPRECATED Tp::RichPresenceAccessControl Tp::Client::ConnectionInterfaceLocationInterface::LocationAccessControl

(

)

const [inline]

Getter for the remote object property "LocationAccessControl".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyLocationAccessControl() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ConnectionInterfaceLocationInterface::requestPropertyLocationAccessControl

(

)

const [inline]

Asynchronous getter for the remote object property "LocationAccessControl" of type Tp::RichPresenceAccessControl.

The current access control mechanism and settings for this connection. Before publishing location for the first time, if this has not been set by a client, implementations SHOULD set it to be as restrictive as possible (an empty whitelist, if supported).

Returns:

A pending variant which will emit finished when the property has been retrieved.

TELEPATHY_QT4_DEPRECATED void Tp::Client::ConnectionInterfaceLocationInterface::setLocationAccessControl

(

const Tp::RichPresenceAccessControl &

newValue

)

[inline]

Setter for the remote object property "LocationAccessControl".

Don't use this: it blocks the main loop.

Parameters:

newValue

The value to set the property to.

Tp::PendingOperation* Tp::Client::ConnectionInterfaceLocationInterface::setPropertyLocationAccessControl

(

Tp::RichPresenceAccessControl

newValue

)

[inline]

Asynchronous setter for the remote object property "LocationAccessControl" of type Tp::RichPresenceAccessControl.

The current access control mechanism and settings for this connection. Before publishing location for the first time, if this has not been set by a client, implementations SHOULD set it to be as restrictive as possible (an empty whitelist, if supported).

Returns:

A pending operation which will emit finished when the property has been set.

TELEPATHY_QT4_DEPRECATED uint Tp::Client::ConnectionInterfaceLocationInterface::SupportedLocationFeatures

(

)

const [inline]

Getter for the remote object property "SupportedLocationFeatures".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertySupportedLocationFeatures() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ConnectionInterfaceLocationInterface::requestPropertySupportedLocationFeatures

(

)

const [inline]

Asynchronous getter for the remote object property "SupportedLocationFeatures" of type uint.

Indicates the Location features supported by this connection. This property MAY be undefined before <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">Status</tp:dbus-ref> becomes Connected, but MUST remain constant thereafter.

Returns:

A pending variant which will emit finished when the property has been retrieved.

Tp::PendingVariantMap* Tp::Client::ConnectionInterfaceLocationInterface::requestAllProperties

(

)

const [inline]

Request all of the DBus properties on the interface.

Returns:

A pending variant map which will emit finished when the properties have been retrieved.

QDBusPendingReply<Tp::ContactLocations> Tp::Client::ConnectionInterfaceLocationInterface::GetLocations

(

const Tp::UIntList &

contacts

)

[inline, slot]

Begins a call to the D-Bus method "GetLocations" on the remote object.

Return the current locations of the given contacts, if they are already known. If any of the given contacts' locations are not known, request their current locations, but return immediately without waiting for a reply; if a reply with a non-empty location is later received for those contacts, the LocationUpdated signal will be emitted for them. This method is appropriate for "lazy" location finding, for instance displaying the location (if available) of everyone in your contact list.

Parameters:

contacts

The contacts whose locations should be returned or signalled.

Returns:

The contacts' locations, if already known. Contacts whose locations are not already known are omitted from the mapping; contacts known to have no location information appear in the mapping with an empty Location dictionary.

QDBusPendingReply<QVariantMap> Tp::Client::ConnectionInterfaceLocationInterface::RequestLocation

(

uint

contact

)

[inline, slot]

Begins a call to the D-Bus method "RequestLocation" on the remote object.

Return the current location of the given contact. If necessary, make a request to the server for up-to-date information, and wait for a reply. This method is appropriate for use in a "Contact Information..." dialog; it can be used to show progress information (while waiting for the method to return), and can distinguish between various error conditions.

Parameters:

contact

The contact whose location should be returned.

Returns:

The contact's location. It MAY be empty, indicating that no location information was found.

QDBusPendingReply Tp::Client::ConnectionInterfaceLocationInterface::SetLocation

(

const QVariantMap &

location

)

[inline, slot]

Begins a call to the D-Bus method "SetLocation" on the remote object.

Set the local user's own location.

Parameters:

location

The location to advertise. If the user wants to obscure their exact location by reducing the precision or accuracy, clients MUST do this themselves, rather than relying on the connection manager to do so. Clients that interact with more than one connection SHOULD advertise the same reduced-accuracy location to all of them, so that contacts cannot obtain an undesirably accurate location by assuming that random errors have been added and averaging the locations advertised on multiple connections.

void Tp::Client::ConnectionInterfaceLocationInterface::LocationUpdated	(	uint	contact,
		const QVariantMap &	location
	)			[signal]

Represents the signal "LocationUpdated" on the remote object.

Emitted when a contact's location changes or becomes known.

Parameters:

	contact	The contact
	location	The contact's location, or empty to indicate that nothing is known about the contact's location.

void Tp::Client::ConnectionInterfaceLocationInterface::invalidate	(	Tp::DBusProxy *	proxy,
		const QString &	error,
		const QString &	message
	)			[protected, virtual]

Reimplemented from Tp::AbstractInterface.

---

Property Documentation

Tp::UIntList Tp::Client::ConnectionInterfaceLocationInterface::LocationAccessControlTypes [read]

Represents property "LocationAccessControlTypes" on the remote object.

The types of access control that are supported by this connection.

Tp::RichPresenceAccessControl Tp::Client::ConnectionInterfaceLocationInterface::LocationAccessControl [read, write]

Represents property "LocationAccessControl" on the remote object.

The current access control mechanism and settings for this connection. Before publishing location for the first time, if this has not been set by a client, implementations SHOULD set it to be as restrictive as possible (an empty whitelist, if supported).

uint Tp::Client::ConnectionInterfaceLocationInterface::SupportedLocationFeatures [read]

Represents property "SupportedLocationFeatures" on the remote object.

Indicates the Location features supported by this connection. This property MAY be undefined before <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">Status</tp:dbus-ref> becomes Connected, but MUST remain constant thereafter.