Methods
| GetLocations | (au: Contacts) | → | a{ua{sv}}: Locations | |
| RequestLocation | (u: Contact) | → | a{sv}: Location | |
| SetLocation | (a{sv}: Location) | → | nothing |
Signals
| LocationUpdated | (u: Contact, a{sv}: Location) |
Properties
| LocationAccessControlTypes | au (Rich_Presence_Access_Control_Type_List) | Read only | |
| LocationAccessControl | (uv) (Rich_Presence_Access_Control) | Read/Write | |
| SupportedLocationFeatures | u (Location_Features) | Read only |
Contact Attributes
| org.freedesktop.Telepathy.Connection.Interface.Location/location | a{sv} (Location) |
Types
| Location_Features | Flags | u | |
| Location | Mapping | a{sv} | |
| Contact_Locations | Mapping | a{ua{sv}} |
Added in 0.17.27.
(as stable API)
Objects implementing this interface must also implement:
Description
An interface on connections to support protocols which allow users to publish their current geographical location, and subscribe to the current location of their contacts.
This interface is geared strongly towards automatic propagation and use of this information, so focuses on latitude, longitude and altitude which can be determined by GPS, although provision is also included for an optional human-readable description of locations. All co-ordinate information is required to be relative to the WGS84 datum.
The information published through this interface is intended to have the same scope as presence information, so will normally be made available to those individuals on the user's "publish" contact list. Even so, user interfaces should not automatically publish location information without the consent of the user, and it is recommended that an option is made available to reduce the accuracy of the reported information to allow the user to maintain their privacy.
Location information is represented using the terminology of XMPP's XEP-0080 or the XEP-0080-derived Geoclue API where possible.
Methods
(Permalink)
GetLocations (au: Contacts) → a{ua{sv}}: Locations
Parameters
- Contacts — au (Contact_Handle_List)
The contacts whose locations should be returned or signalled.
Returns
- Locations — a{ua{sv}} (Contact_Locations)
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.
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.
Possible Errors
- Disconnected
- Invalid Handle
The connection is not currently connected and cannot be used.
This error may also be raised when operations are performed on a
Connection for which
StatusChanged
has signalled status Disconnected for reason None.
The second usage corresponds to None in the
Connection_Status_Reason enum; if a better reason
is available, the corresponding error should be used instead.
The handle specified is unknown on this channel or connection.
(Permalink)
RequestLocation (u: Contact) → a{sv}: Location
Parameters
- Contact — u (Contact_Handle)
The contact whose location should be returned.
Returns
- Location — a{sv} (Location)
The contact's location. It MAY be empty, indicating that no location
information was found.
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.
Possible Errors
- Disconnected
- Network Error
- Invalid Handle
- Permission Denied
The connection is not currently connected and cannot be used.
This error may also be raised when operations are performed on a
Connection for which
StatusChanged
has signalled status Disconnected for reason None.
The second usage corresponds to None in the
Connection_Status_Reason enum; if a better reason
is available, the corresponding error should be used instead.
Raised when there is an error reading from or writing to the network.
The handle specified is unknown on this channel or connection.
The requested contact does not allow the local user to see their
location information.
(Permalink)
SetLocation (a{sv}: Location) → nothing
Parameters
- Location — a{sv}
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.
Set the local user's own location.
Possible Errors
- Disconnected
- Not Implemented
- Permission Denied
The connection is not currently connected and cannot be used.
This error may also be raised when operations are performed on a
Connection for which
StatusChanged
has signalled status Disconnected for reason None.
The second usage corresponds to None in the
Connection_Status_Reason enum; if a better reason
is available, the corresponding error should be used instead.
The user's server does not support publishing their own location.
If it is possible to determine this ahead of time, the
Can_Set flag will not be set in
SupportedLocationFeatures.
The user is not permitted to perform the requested operation.
Signals
(Permalink)
LocationUpdated (u: Contact, a{sv}: Location)
Parameters
- Contact — u (Contact_Handle)
- Location — a{sv} (Location)
The contact
The contact's location, or empty to indicate that nothing is known
about the contact's location.
Emitted when a contact's location changes or becomes known.
Properties
Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)
LocationAccessControlTypes — au (Rich_Presence_Access_Control_Type_List)
Read only
The types of access control that are supported by this
connection.
(Permalink)
LocationAccessControl — (uv) (Rich_Presence_Access_Control)
Read/Write
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).
(Permalink)
SupportedLocationFeatures — u (Location_Features)
Read only
Added in UNRELEASED.
Indicates the Location features supported by this connection. This
property MAY be undefined before Status
becomes
Connected, but MUST remain constant thereafter.
Contact Attributes
Attributes that a contact can have, accessed with the
org.freedesktop.Telepathy.Connection.Interface.Contacts interface.
(Permalink)
org.freedesktop.Telepathy.Connection.Interface.Location/location — a{sv} (Location)
The same mapping that would be returned by GetLocations for this contact. Omitted from the result if the contact's location is not known.
Types
Flags (Permalink)
Location_Features — u
Flags describing the Location features which may be supported on any
given connection.
- Can_Set (1)
Indicates that setting your own location with
SetLocation is supported on this
connection.
Mapping (Permalink)
Location — a{sv}
A user's location, represented as an extensible mapping.
- Key — s
- countrycode - s: an ISO-3166-1 alpha-2 (two-letter) country code, e.g. "us", "gb", "fr"
- country - s: a country name in unspecified locale, e.g. "USA"
- region - s: an administrative region of the nation, such as a state or province
- locality - s: a locality within the administrative region, such as a town or city
- area - s: a named area such as a campus or neighborhood
- postalcode - s: a code used for postal delivery
- street - s: a thoroughfare within the locality, or a crossing of two thoroughfares
- building - s: a specific building on a street or in an area
- floor - s: a particular floor in a building
- room - s: a particular room in a building
- text - s: any more specific information, e.g. "Northwest corner of the lobby"
- description - s: A natural-language name for or description of the location, e.g. "Bill's house"
- uri - s: a URI representing the location or pointing to more information about it
- language - s: a specific language or locale of location information in a format compatible to RFC 4646. Note that UTF-8 is the only allowed encoding, e.g. "en" or "fr-CA".
- lat - d: latitude in decimal degrees north, -90 to +90,
relative to the WGS-84 datum
This is from XEP-0080; the XEP allows use of a different datum, but recommends this one. We enforce sanity by requiring a consistent datum: a minimal compliant implementation of this specification in terms of XEP-0080 would simply ignore the <lat> and <lon> elements if <datum> exists and has a value other than WGS-84, while an advanced implementation might correct for the different datum.
- lon - d: Longitude in decimal degrees east, -180 to +180,
relative to the WGS-84 datum
Same rationale as 'lat'
- alt - d: altitude in metres above sea level (negative
if below sea level)
This is from XEP-0080
- accuracy - d: horizontal position error in metres if
known
This is from XEP-0080
- speed - d: speed in metres per second
This is from XEP-0080
- bearing - d: direction of movement in decimal degrees,
where North is 0 and East is 90
This is from XEP-0080, and is equivalent to the struct field called "direction" in GeoClue
- timestamp - x (Unix_Timestamp64): the time
that the contact was at this location, in seconds since
1970-01-01T00:00:00Z (i.e. the beginning of 1970 in UTC)
XEP-0080 uses an ISO 8601 string for this, but a number of seconds since the epoch is probably easier to work with.
- Value — v
Civic addresses are represented by the following well-known keys (all of which have string values), which should be kept in sync with those used in XEP-0080 and in the Geoclue project:
The following address keys are defined in XEP-0080 but not by Geoclue, and are also allowed:
Since the previous strings have data intended to be read by users, the language used should be stated using:
Positions are represented by the following well-known keys:
Velocities are represented by the following well-known keys:
Other well-known keys:
The value corresponding to the well-known key.
Mapping (Permalink)
Contact_Locations — a{ua{sv}}
A map from contacts to their locations.
- Contact — u (Contact_Handle)
- Location — a{sv} (Location)
A contact
The contact's location, which MAY be empty to indicate
that the contact's location is unknown