#include <TelepathyQt4/Client/Channel>
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 |
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.
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.
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.
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.
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.
mainInterface | The proxy to use. | |
parent | Passed to the parent class constructor. |
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.
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:
rooms | An array of structs containing:
|
virtual void Telepathy::Client::ChannelTypeRoomListInterface::invalidate | ( | Telepathy::Client::DBusProxy * | , | |
const QString & | , | |||
const QString & | ||||
) | [protected, virtual] |
Reimplemented from Telepathy::Client::AbstractInterface.
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.
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.
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.
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().
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.