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

#include <TelepathyQt4/Client/Channel>

Inheritance diagram for Telepathy::Client::ChannelTypeRoomListInterface:

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

Collaboration graph
[legend]

List of all members.

Public Slots

QDBusPendingReply< bool > GetListingRooms ()
QDBusPendingReply ListRooms ()
QDBusPendingReply StopListing ()

Signals

void GotRooms (const Telepathy::RoomInfoList &rooms)
void ListingRooms (bool listing)

Public Member Functions

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

Static Public Member Functions

static const char * staticInterfaceName ()

Protected Member Functions

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

Properties

QString Server


Detailed Description

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

Constructor & Destructor Documentation

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

Creates a ChannelTypeRoomListInterface 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::ChannelTypeRoomListInterface::ChannelTypeRoomListInterface ( const QDBusConnection &  connection,
const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a ChannelTypeRoomListInterface 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::ChannelTypeRoomListInterface::ChannelTypeRoomListInterface ( Telepathy::Client::DBusProxy proxy  ) 

Creates a ChannelTypeRoomListInterface 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::ChannelTypeRoomListInterface::ChannelTypeRoomListInterface ( const Telepathy::Client::ChannelInterface mainInterface  )  [explicit]

Creates a ChannelTypeRoomListInterface 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::ChannelTypeRoomListInterface::ChannelTypeRoomListInterface ( const Telepathy::Client::ChannelInterface mainInterface,
QObject *  parent 
)

Creates a ChannelTypeRoomListInterface 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<bool> Telepathy::Client::ChannelTypeRoomListInterface::GetListingRooms (  )  [inline, slot]

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

Check to see if there is already a room list request in progress on this channel.

Returns:
A boolean indicating if room listing is in progress

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

void Telepathy::Client::ChannelTypeRoomListInterface::GotRooms ( const Telepathy::RoomInfoList rooms  )  [signal]

Represents the signal "GotRooms" on the remote object.

Emitted when information about rooms on the server becomes available. The array contains the room handle (as can be passed to the <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">RequestChannel</tp:dbus-ref> method with HANDLE_TYPE_ROOM), the channel type, and a dictionary containing further information about the room as available. The following well-known keys and types are recommended for use where appropriate:

handle-name (s)
The string name of the room handle (as would be returned by <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection">InspectHandles</tp:dbus-ref>)

name (s)
The human-readable name of the room if different from the handle

description (s)
A description of the room's overall purpose

subject (s)
The current subject of conversation in the room

members (u)
The number of members of the room

password (b)
True if the room requires a password to enter

invite-only (b)
True if you cannot join the room, but must be invited

Parameters:
rooms An array of structs containing:
  • an integer room handle
  • a string representing the D-Bus interface name of the channel type
  • a dictionary mapping string keys to variant boxed information

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

void Telepathy::Client::ChannelTypeRoomListInterface::ListingRooms ( bool  listing  )  [signal]

Represents the signal "ListingRooms" on the remote object.

Emitted to indicate whether or not room listing request is currently in progress.

Parameters:
listing A boolean indicating if room listing is in progress

QDBusPendingReply Telepathy::Client::ChannelTypeRoomListInterface::ListRooms (  )  [inline, slot]

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

Request the list of rooms from the server. The ListingRooms (True) signal should be emitted when this request is being processed, GotRooms when any room information is received, and ListingRooms (False) when the request is complete.

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

QString Telepathy::Client::ChannelTypeRoomListInterface::Server (  )  const [inline]

Getter for the remote object property "Server".

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

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

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

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

Returns:
The D-Bus interface name.

QDBusPendingReply Telepathy::Client::ChannelTypeRoomListInterface::StopListing (  )  [inline, slot]

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

Stop the room listing if it's in progress, but don't close the channel. The ListingRooms (False) signal should be emitted when the listing stops.

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


Property Documentation

QString Telepathy::Client::ChannelTypeRoomListInterface::Server [read]

Represents property "Server" on the remote object.

For protocols with a concept of chatrooms on multiple servers with different DNS names (like XMPP), the DNS name of the server whose rooms are listed by this channel, e.g. "conference.jabber.org". Otherwise, the empty string. This property cannot change during the lifetime of the channel.


Generated on Thu Mar 5 18:52:00 2009 for TelepathyQt4-0.1.1 by  doxygen 1.5.8