Interface Channel.Interface.Subject2

Interface Index (Compact) | Summary | Description | Methods | Properties

Methods

SetSubject (s: Subject) → nothing

Properties

Subject s Read only
Actor s Read only
ActorHandle u (Contact_Handle) Read only
Timestamp x (Unix_Timestamp64) Read only
CanSet b Read only
Added in 0.24.0. (version 2)
Objects implementing this interface must also implement:

Description

An interface channels can implement to support subjects. Most of the time this will be implemented by channels implementing the Room2 interface, but some protocols support subjects in 1-to-1 chats (such as XMPP). Note that this interface is not restricted to Text channels, and can also be used on Call channels.

Methods

(Permalink)

SetSubject (s: Subject) → nothing

Parameters

  • Subject — s
    • The new subject.

Set the room's subject. Clients SHOULD look at the subject flags before calling this method as the user might not have permission to set the subject.

A successful return of this method indicates a successful change in subject, but clients should still listen for changes to the Subject property for further changes by other users or the server.

Possible Errors

  • Not Implemented
    • Raised when the requested method, channel, etc is not available on this connection.
  • Permission Denied
    • The user is not permitted to perform the requested operation.

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

Subject — s

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

The human-readable subject on the channel such as the topic in an IRC channel, or the room name in XMPP MUCs.

Rationale:
This property replaces the subject Telepathy property of Text channels, as Telepathy properties are soon to be deprecated completely.

This property may change during the lifetime of the channel and MUST not be included in a channel request.

(Permalink)

Actor — s

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

The normalized contact ID representing who last modified the subject, or the empty string if it is not known.

Rationale:
This property replaces the subject-contact Telepathy property of Text channels, as Telepathy properties are soon to be deprecated completely.
(Permalink)

ActorHandle — u (Contact_Handle)

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

The handle corresponding to Actor, or 0 if the Actor is unknown.

(Permalink)

Timestamp — x (Unix_Timestamp64)

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

A unix timestamp indicating when the subject was last modified, or INT_MAX64 if unknown.

Rationale:
This property replaces the subject-timestamp Telepathy property of Text channels, as Telepathy properties are soon to be deprecated completely.
(Permalink)

CanSet — b

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

TRUE if the Subject property can be set by the user by calling SetSubject, otherwise FALSE.

If implementations are unsure of what this value should be it SHOULD still be set to what it believes the value is. As a result, clients should be aware that SetSubject can still fail even with this property set to TRUE.

Rationale:
In XMPP it is impossible to know whether an occupant can set the subject as XMPP server implementations are wildly inconsistent.