Telepathy::Client::ChannelInterfaceHoldInterface Class Reference
[Channel proxies]

#include <TelepathyQt4/Client/Channel>

Inheritance diagram for Telepathy::Client::ChannelInterfaceHoldInterface:

Inheritance graph
[legend]
Collaboration diagram for Telepathy::Client::ChannelInterfaceHoldInterface:

Collaboration graph
[legend]

List of all members.

Public Slots

QDBusPendingReply< uint, uint > GetHoldState ()
QDBusPendingReply RequestHold (bool hold)

Signals

void HoldStateChanged (uint holdState, uint reason)

Public Member Functions

 ChannelInterfaceHoldInterface (const QString &serviceName, const QString &objectPath, QObject *parent=0)
 ChannelInterfaceHoldInterface (const QDBusConnection &connection, const QString &serviceName, const QString &objectPath, QObject *parent=0)
 ChannelInterfaceHoldInterface (Telepathy::Client::DBusProxy *proxy)
 ChannelInterfaceHoldInterface (const Telepathy::Client::ChannelInterface &mainInterface)
 ChannelInterfaceHoldInterface (const Telepathy::Client::ChannelInterface &mainInterface, QObject *parent)

Static Public Member Functions

static const char * staticInterfaceName ()

Protected Member Functions

virtual void invalidate (Telepathy::Client::DBusProxy *, const QString &, const QString &)


Detailed Description

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

Constructor & Destructor Documentation

Telepathy::Client::ChannelInterfaceHoldInterface::ChannelInterfaceHoldInterface ( const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

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

Parameters:
serviceName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.

Telepathy::Client::ChannelInterfaceHoldInterface::ChannelInterfaceHoldInterface ( const QDBusConnection &  connection,
const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

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

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

Telepathy::Client::ChannelInterfaceHoldInterface::ChannelInterfaceHoldInterface ( Telepathy::Client::DBusProxy proxy  ) 

Creates a ChannelInterfaceHoldInterface 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.

Telepathy::Client::ChannelInterfaceHoldInterface::ChannelInterfaceHoldInterface ( const Telepathy::Client::ChannelInterface mainInterface  )  [explicit]

Creates a ChannelInterfaceHoldInterface 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.

Telepathy::Client::ChannelInterfaceHoldInterface::ChannelInterfaceHoldInterface ( const Telepathy::Client::ChannelInterface mainInterface,
QObject *  parent 
)

Creates a ChannelInterfaceHoldInterface 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

QDBusPendingReply<uint, uint> Telepathy::Client::ChannelInterfaceHoldInterface::GetHoldState (  )  [inline, slot]

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

Return whether the local user has placed the channel on hold.

Returns:
The state of the channel

Returns:
The reason why the channel is in that state

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

void Telepathy::Client::ChannelInterfaceHoldInterface::HoldStateChanged ( uint  holdState,
uint  reason 
) [signal]

Represents the signal "HoldStateChanged" on the remote object.

Emitted to indicate that the hold state has changed for this channel. This may occur as a consequence of you requesting a change with RequestHold, or the state changing as a result of a request from another process.

Parameters:
holdState The state of the channel
reason The reason for the state change

virtual void Telepathy::Client::ChannelInterfaceHoldInterface::invalidate ( Telepathy::Client::DBusProxy ,
const QString &  ,
const QString &   
) [protected, virtual]

QDBusPendingReply Telepathy::Client::ChannelInterfaceHoldInterface::RequestHold ( bool  hold  )  [inline, slot]

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

Request that the channel be put on hold (be instructed not to send any media streams to you) or be taken off hold.

If the connection manager can immediately tell that the requested state change could not possibly succeed, this method SHOULD return the NotAvailable error. If the requested state is the same as the current state, this method SHOULD return successfully without doing anything.

Otherwise, this method SHOULD immediately set the hold state to Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold (as appropriate), emitting <tp:member-ref>HoldStateChanged</tp:member-ref> if this is a change, and return successfully.

The eventual success or failure of the request is indicated by a subsequent HoldStateChanged signal, changing the hold state to Local_Hold_State_Held or Local_Hold_State_Unheld.

If the channel has multiple streams, and the connection manager succeeds in changing the hold state of one stream but fails to change the hold state of another, it SHOULD attempt to revert all streams to their previous hold states.

The following state transitions SHOULD be used, where appropriate:

  • Successful hold: (Unheld, any reason) → (Pending_Hold, Requested) → (Held, Requested)
  • Successful unhold: (Held, any reason) → (Pending_Unhold, Requested) → (Unheld, Requested)
  • Attempting to unhold fails at the first attempt to acquire a resource: (Held, any reason) → (Pending_Unhold, Requested) → (Held, Resource_Not_Available)
  • Attempting to unhold acquires one resource, but fails to acquire a second, and takes time to release the first: (Held, any reason) → (Pending_Unhold, Requested) → (Pending_Hold, Resource_Not_Available) → (Held, Resource_Not_Available)

Parameters:
hold A boolean indicating whether or not the channel should be on hold

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

static const char* Telepathy::Client::ChannelInterfaceHoldInterface::staticInterfaceName (  )  [inline, static]

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

Returns:
The D-Bus interface name.


Generated on Thu Mar 5 18:51:59 2009 for TelepathyQt4-0.1.1 by  doxygen 1.5.8