Home · All Classes · All Namespaces · Modules · Functions · Files
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
Tp::BaseProtocolAddressingInterface Class Reference

Base class for implementations of Protocol.Interface.Addressing. More...

#include <TelepathyQt/BaseProtocolAddressingInterface>

Inherits Tp::AbstractProtocolInterface.

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

Base class for implementations of Protocol.Interface.Addressing.


Member Typedef Documentation

typedef Callback3<QString, const QString &, const QString &, DBusError*> Tp::BaseProtocolAddressingInterface::NormalizeVCardAddressCallback

Constructor & Destructor Documentation

Class destructor.

Class constructor.


Member Function Documentation

static BaseProtocolAddressingInterfacePtr Tp::BaseProtocolAddressingInterface::create ( ) [inline, static]
template<typename BaseProtocolAddressingInterfaceSubclass >
static SharedPtr<BaseProtocolAddressingInterfaceSubclass> Tp::BaseProtocolAddressingInterface::create ( ) [inline, static]

Return the immutable properties of this interface.

Immutable properties cannot change after the interface has been registered on a service on the bus with registerInterface().

Returns:
The immutable properties of this interface.

Implements Tp::AbstractDBusServiceInterface.

Return the list of addressable vcard fields that have been set with setAddressableVCardFields().

This list is exposed as the AddressableVCardFields property of this interface on the bus and represents the vcard fields that can be used to request a contact for this protocol, normalized to lower case.

Returns:
The list of addressable vcard fields that have been set with setAddressableVCardFields().
See also:
setAddressableVCardFields()
void Tp::BaseProtocolAddressingInterface::setAddressableVCardFields ( const QStringList &  vcardFields)

Set the list of vcard fields that can be used to request a contact for this protocol.

All the field names should be normalized to lower case.

Parameters:
vcardFieldsThe list of vcard fields to set.
See also:
addressableVCardFields()

Return the list of URI schemes that have been set with setAddressableUriSchemes().

This list is exposed as the AddressableURISchemes property of this interface on the bus and represents the URI schemes that are supported by this protocol, like "tel" or "sip".

Returns:
The list of addressable URI schemes that have been set with setAddressableUriSchemes().
See also:
setAddressableUriSchemes()
void Tp::BaseProtocolAddressingInterface::setAddressableUriSchemes ( const QStringList &  uriSchemes)

Set the list of URI schemes that are supported by this protocol.

Parameters:
uriSchemesThe list of URI schemes to set.
See also:
addressableUriSchemes()

Set a callback that will be called from a client to normalize a given vcard address.

This callback will be called when the NormalizeVCardAddress method on the Protocol.Interface.Addressing D-Bus interface has been called.

Parameters:
cbThe callback to set.
See also:
normalizeVCardAddress()
QString Tp::BaseProtocolAddressingInterface::normalizeVCardAddress ( const QString &  vcardField,
const QString &  vcardAddress,
DBusError error 
)

Return a normalized version of the given vcardAddress, which corresponds to the given vcardField, by calling the callback that has been set with setNormalizeVCardAddressCallback().

Parameters:
vcardFieldThe vcard field of the address we are normalizing.
vcardAddressThe address to normalize, which is assumed to belong to a contact.
errorA pointer to a DBusError instance where any possible error will be stored.
Returns:
A normalized version of the given vcardAddress, or an empty string if no callback to do the normalization has been set with setNormalizeVCardAddressCallback().
See also:
setNormalizeVCardAddressCallback()

Set a callback that will be called from a client to normalize a given contact URI.

This callback will be called when the NormalizeContactURI method on the Protocol.Interface.Addressing D-Bus interface has been called.

Parameters:
cbThe callback to set.
See also:
normalizeContactUri()
QString Tp::BaseProtocolAddressingInterface::normalizeContactUri ( const QString &  uri,
DBusError error 
)

Return a normalized version of the given contact URI, uri, by calling the callback that has been set with setNormalizeContactUriCallback().

Parameters:
uriThe contact URI to normalize.
errorA pointer to a DBusError instance where any possible error will be stored.
Returns:
A normalized version of the given uri, or an empty string if no callback to do the normalization has been set with setNormalizeContactUriCallback().
See also:
setNormalizeContactUriCallback()


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt 0.9.3