Home · All Classes · All Namespaces · Modules · Functions · Files |
#include <TelepathyQt/Channel>
Inherits Tp::AbstractInterface.
Public Slots | |
QDBusPendingReply | UpdateConfiguration (const QVariantMap &properties, int timeout=-1) |
Static Public Member Functions | |
static QLatin1String | staticInterfaceName () |
Protected Member Functions | |
virtual void | invalidate (Tp::DBusProxy *, const QString &, const QString &) |
Protected Member Functions inherited from Tp::AbstractInterface | |
AbstractInterface (DBusProxy *proxy, const QLatin1String &interface) | |
AbstractInterface (const QString &busName, const QString &path, const QLatin1String &interface, const QDBusConnection &connection, QObject *parent) | |
PendingVariant * | internalRequestProperty (const QString &name) const |
PendingOperation * | internalSetProperty (const QString &name, const QVariant &newValue) |
PendingVariantMap * | internalRequestAllProperties () const |
Additional Inherited Members | |
Signals inherited from Tp::AbstractInterface | |
void | propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties) |
Protected Slots inherited from Tp::AbstractInterface |
Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.RoomConfig1".
Tp::Client::ChannelInterfaceRoomConfigInterface::ChannelInterfaceRoomConfigInterface | ( | const QString & | busName, |
const QString & | objectPath, | ||
QObject * | parent = 0 |
||
) |
Creates a ChannelInterfaceRoomConfigInterface associated with the given object on the session bus.
busName | Name of the service the object is on. |
objectPath | Path to the object on the service. |
parent | Passed to the parent class constructor. |
Tp::Client::ChannelInterfaceRoomConfigInterface::ChannelInterfaceRoomConfigInterface | ( | const QDBusConnection & | connection, |
const QString & | busName, | ||
const QString & | objectPath, | ||
QObject * | parent = 0 |
||
) |
Creates a ChannelInterfaceRoomConfigInterface associated with the given object on the given bus.
connection | The bus via which the object can be reached. |
busName | Name of the service the object is on. |
objectPath | Path to the object on the service. |
parent | Passed to the parent class constructor. |
Tp::Client::ChannelInterfaceRoomConfigInterface::ChannelInterfaceRoomConfigInterface | ( | Tp::DBusProxy * | proxy | ) |
Creates a ChannelInterfaceRoomConfigInterface associated with the same object as the given proxy.
proxy | The proxy to use. It will also be the QObject::parent() for this object. |
|
explicit |
Creates a ChannelInterfaceRoomConfigInterface 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. |
Tp::Client::ChannelInterfaceRoomConfigInterface::ChannelInterfaceRoomConfigInterface | ( | const Tp::Client::ChannelInterface & | mainInterface, |
QObject * | parent | ||
) |
Creates a ChannelInterfaceRoomConfigInterface 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. |
|
inlinestatic |
Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.RoomConfig1", which this class represents.
|
inline |
Asynchronous getter for the remote object property Anonymous
of type bool
.
True if people may join the channel without other members being made aware of their identity.
|
inline |
Asynchronous getter for the remote object property InviteOnly
of type bool
.
True if people may not join the channel until they have been invited.
|
inline |
Asynchronous getter for the remote object property Limit
of type uint
.
The limit to the number of members; or 0 if there is no limit.
|
inline |
Asynchronous getter for the remote object property Moderated
of type bool
.
True if channel membership is not sufficient to allow participation.
|
inline |
Asynchronous getter for the remote object property Title
of type QString
.
A human-visible name for the channel, if it differs from ChannelInterfaceRoomInterface::RoomName ; the empty string, otherwise.
On XMPP, this represents the muc#roomconfig_roomname
field of the muc#roomconfig
form. So for jdev@conference.jabber.org
, for example:
"jdev"
;"conference.jabber.org"
;"General Jabber
development discussion"
.XEP-0045 is awful.
|
inline |
Asynchronous getter for the remote object property Description
of type QString
.
A human-readable description of the channel's overall purpose; if any.
|
inline |
Asynchronous getter for the remote object property Persistent
of type bool
.
True
if the channel will remain in existence on the server after all
members have left it.
|
inline |
Asynchronous getter for the remote object property Private
of type bool
.
True
if the channel is not visible to non-members.
|
inline |
Asynchronous getter for the remote object property PasswordProtected
of type bool
.
True
if contacts joining this channel must provide a
password to be granted entry. Note that this property does not
indicate that a password is required right now; see the
ChannelInterfacePasswordInterface
interface for the API used to provide a password while joining a room.
|
inline |
Asynchronous getter for the remote object property Password
of type QString
.
If PasswordProtected is
True
, the password required to enter the channel, if
known. If the password is unknown, or
PasswordProtected is
False
, the empty string.
|
inline |
Asynchronous getter for the remote object property PasswordHint
of type QString
.
If PasswordProtected is
True
, an optional hint for the password.
On protocols supporting PasswordHint (indicated by its presence in MutableProperties ), Password and PasswordHint MUST be set in a single call to UpdateConfiguration() .
|
inline |
Asynchronous getter for the remote object property CanUpdateConfiguration
of type bool
.
If True
, the user may call
UpdateConfiguration() to change the values
of the properties listed in
MutableProperties .
|
inline |
Asynchronous getter for the remote object property MutableProperties
of type QStringList
.
A list of (unqualified) property names on this interface which may
be modified using UpdateConfiguration()
(if CanUpdateConfiguration is
True
). Properties not listed here cannot be
modified.
For example, IRC does not have the concept of joining a room without
other participants knowing your true identity; so on IRC the
Anonymous property will always be
False
, and
MutableProperties will not include
"Anonymous"
.
|
inline |
Asynchronous getter for the remote object property ConfigurationRetrieved
of type bool
.
True
once the initial room configuration has been
retrieved, or False
otherwise. On some services, this
may take some time after you've joined a room to fetch the
configuration. Once this property changes to True
, the
other properties on this interface can be assumed to be accurate;
this property MUST not change to False
after it becomes
True
.
An application's “configure this room” dialog might choose to
display a spinner while this property is False
, rather
than allowing the user to edit probably-inaccurate
configuration.
|
inline |
Request all of the DBus properties on the interface.
|
inlineslot |
Begins a call to the D-Bus method UpdateConfiguration
on the remote object.
If CanUpdateConfiguration is
True
, modifies the current values of one or more
room properties. This method SHOULD NOT return until the change has
been accepted or declined by the server.
Note that the server may ostensibly accept the changes (thus
allowing this method to return success) but signal different values;
for example, the server might truncate
Title to some maximum length. Callers
SHOULD continue to listen for the PropertiesChanged
signal, and trust the values it signals over those provided to this
method.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
properties |
The new values of one or more properties on this interface, which must be listed in MutableProperties . For instance, to set up a channel for discussing top-secret corporate merge plans, this parameter might be: { 'Private': True, 'InviteOnly': True, 'Description': "The first rule of #inteltakeover is: do not talk about #inteltakeover", } |
timeout | The timeout in milliseconds. |
|
protectedvirtual |
Reimplemented from Tp::AbstractInterface.
Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation | Telepathy-Qt 0.9.7 |