Tp::ChannelFactory Class Reference [Channel proxies]

Constructs Channel objects. More...

#include <TelepathyQt4/ChannelFactory>

Inherits Tp::DBusProxyFactory.

List of all members.

Classes

• struct Constructor
• struct SubclassCtor

Public Types

• typedef SharedPtr< Constructor > ConstructorPtr
• typedef SharedPtr< const
  Constructor > ConstructorConstPtr

Public Member Functions

• virtual ~ChannelFactory ()
• Features featuresForTextChats (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForTextChats (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForTextChats (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForTextChats (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForTextChats (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features featuresForTextChatrooms (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForTextChatrooms (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForTextChatrooms (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForTextChatrooms (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForTextChatrooms (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features featuresForStreamedMediaCalls (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForStreamedMediaCalls (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForStreamedMediaCalls (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForStreamedMediaCalls (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForStreamedMediaCalls (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features featuresForRoomLists (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForRoomLists (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForRoomLists (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForRoomLists (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForRoomLists (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features featuresForOutgoingFileTransfers (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForOutgoingFileTransfers (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForOutgoingFileTransfers (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForOutgoingFileTransfers (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForOutgoingFileTransfers (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features featuresForIncomingFileTransfers (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForIncomingFileTransfers (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForIncomingFileTransfers (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForIncomingFileTransfers (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForIncomingFileTransfers (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features featuresForContactSearches (const QVariantMap &additionalProps=QVariantMap()) const
• void addFeaturesForContactSearches (const Features &features, const QVariantMap &additionalProps=QVariantMap())
• ConstructorConstPtr constructorForContactSearches (const QVariantMap &additionalProps=QVariantMap()) const
• template<typename Subclass > void setSubclassForContactSearches (const QVariantMap &additionalProps=QVariantMap())
• void setConstructorForContactSearches (const ConstructorConstPtr &ctor, const QVariantMap &additionalProps=QVariantMap())
• Features commonFeatures () const
• void addCommonFeatures (const Features &features)
• ConstructorConstPtr fallbackConstructor () const
• template<typename Subclass > void setFallbackSubclass ()
• void setFallbackConstructor (const ConstructorConstPtr &ctor)
• Features featuresFor (const ChannelClassSpec &channelClass) const
• void addFeaturesFor (const ChannelClassSpec &channelClass, const Features &features)
• template<typename Subclass > void setSubclassFor (const ChannelClassSpec &channelClass)
• ConstructorConstPtr constructorFor (const ChannelClassSpec &channelClass) const
• void setConstructorFor (const ChannelClassSpec &channelClass, const ConstructorConstPtr &ctor)
• PendingReady * proxy (const ConnectionPtr &connection, const QString &channelPath, const QVariantMap &immutableProperties) const

Static Public Member Functions

• static ChannelFactoryPtr create (const QDBusConnection &bus)

Protected Member Functions

• ChannelFactory (const QDBusConnection &bus)
• virtual QString finalBusNameFrom (const QString &uniqueOrWellKnown) const
• virtual Features featuresFor (const SharedPtr< RefCounted > &proxy) const

---

Detailed Description

Constructs Channel objects.

Todo:

This class is currently only a placeholder to enable using factories in general in other classes. There is no actual configurability in the construction behavior, although a factory-style construction API is provided.

---

Member Typedef Documentation

typedef SharedPtr<Constructor> Tp::ChannelFactory::ConstructorPtr

typedef SharedPtr<const Constructor> Tp::ChannelFactory::ConstructorConstPtr

---

Constructor & Destructor Documentation

Tp::ChannelFactory::~ChannelFactory

(

)

[virtual]

Class destructor.

Tp::ChannelFactory::ChannelFactory

(

const QDBusConnection &

bus

)

[protected]

Class constructor.

The constructed factory will construct channel subclasses provided by TelepathyQt4 as appropriate for the channel immutable properties, but not make any features ready.

Parameters:

bus

The QDBusConnection the proxies constructed using this factory should use.

---

Member Function Documentation

ChannelFactoryPtr Tp::ChannelFactory::create

(

const QDBusConnection &

bus

)

[static]

Create a new ChannelFactory object for the given bus.

The returned factory will construct channel subclasses provided by TelepathyQt4 as appropriate for the channel immutable properties, but not make any features ready.

Parameters:

bus

The QDBusConnection the proxies constructed using this factory should use.

Returns:

An ChannelFactoryPtr pointing to the newly created factory.

Features Tp::ChannelFactory::featuresForTextChats

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForTextChats	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForTextChats

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForTextChats

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForTextChats	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::featuresForTextChatrooms

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForTextChatrooms	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForTextChatrooms

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForTextChatrooms

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForTextChatrooms	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::featuresForStreamedMediaCalls

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForStreamedMediaCalls	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForStreamedMediaCalls

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForStreamedMediaCalls

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForStreamedMediaCalls	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::featuresForRoomLists

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForRoomLists	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForRoomLists

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForRoomLists

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForRoomLists	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::featuresForOutgoingFileTransfers

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForOutgoingFileTransfers	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForOutgoingFileTransfers

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForOutgoingFileTransfers

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForOutgoingFileTransfers	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::featuresForIncomingFileTransfers

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForIncomingFileTransfers	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForIncomingFileTransfers

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForIncomingFileTransfers

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForIncomingFileTransfers	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::featuresForContactSearches

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

void Tp::ChannelFactory::addFeaturesForContactSearches	(	const Features &	features,
		const QVariantMap &	additionalProps = QVariantMap()
	)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorForContactSearches

(

const QVariantMap &

additionalProps = QVariantMap()

)

const

template<typename Subclass >

void Tp::ChannelFactory::setSubclassForContactSearches

(

const QVariantMap &

additionalProps = QVariantMap()

)

[inline]

void Tp::ChannelFactory::setConstructorForContactSearches	(	const ConstructorConstPtr &	ctor,
		const QVariantMap &	additionalProps = QVariantMap()
	)

Features Tp::ChannelFactory::commonFeatures

(

)

const

void Tp::ChannelFactory::addCommonFeatures

(

const Features &

features

)

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::fallbackConstructor

(

)

const

template<typename Subclass >

void Tp::ChannelFactory::setFallbackSubclass

(

)

[inline]

void Tp::ChannelFactory::setFallbackConstructor

(

const ConstructorConstPtr &

ctor

)

Features Tp::ChannelFactory::featuresFor

(

const ChannelClassSpec &

channelClass

)

const

void Tp::ChannelFactory::addFeaturesFor	(	const ChannelClassSpec &	channelClass,
		const Features &	features
	)

template<typename Subclass >

void Tp::ChannelFactory::setSubclassFor

(

const ChannelClassSpec &

channelClass

)

[inline]

ChannelFactory::ConstructorConstPtr Tp::ChannelFactory::constructorFor

(

const ChannelClassSpec &

channelClass

)

const

void Tp::ChannelFactory::setConstructorFor	(	const ChannelClassSpec &	channelClass,
		const ConstructorConstPtr &	ctor
	)

PendingReady * Tp::ChannelFactory::proxy	(	const ConnectionPtr &	connection,
		const QString &	channelPath,
		const QVariantMap &	immutableProperties
	)			const

Constructs a Channel proxy and begins making it ready.

If a valid proxy already exists in the factory cache for the given combination of busName and objectPath, it is returned instead. All newly created proxies are automatically cached until they're either DBusProxy::invalidated() or the last reference to them outside the factory has been dropped.

The proxy can be accessed immediately after this function returns using PendingReady::proxy().

Todo:

Make it configurable which subclass is constructed.

Parameters:

	connection	Proxy for the owning connection of the channel.
	channelPath	The object path of the channel.
	immutableProperties	The immutable properties of the channel.

Returns:

A PendingReady operation with the proxy in PendingReady::proxy().

QString Tp::ChannelFactory::finalBusNameFrom

(

const QString &

uniqueOrWellKnown

)

const [protected, virtual]

Transforms well-known names to the corresponding unique names, as is appropriate for Channel

Parameters:

uniqueOrWellKnown

The name to transform.

Returns:

The unique name corresponding to uniqueOrWellKnown (which may be it itself).

Implements Tp::DBusProxyFactory.

Features Tp::ChannelFactory::featuresFor

(

const SharedPtr< RefCounted > &

proxy

)

const [protected, virtual]

Returns features as configured for the channel class given by the Channel::immutableProperties() of proxy.

Todo:

Make the features configurable - currently an empty set is always returned.

Parameters:

proxy

The Channel proxy to determine the features for.

Returns:

The channel class-specific features.

Implements Tp::DBusProxyFactory.