WARNING:
This interface is draft and is likely to cause havoc
to your API/ABI if bindings are generated. Do not include this interface
in libraries that care about compatibility.
Added in 0.25.0.
Objects implementing this interface must also implement:
Description
An interface channels can implement to support a picture. Most
of the time this will be implemented by channels implementing
the Room2
interface. Note that this interface is not restricted to
Text channels, and can also be used on Call channels.
Rationale:
This is a separate interface from
RoomConfig1
because (a) it's possible some protocol might support pictures for
1:1 chats; and (b) it avoids downloading an unwanted picture in a
GetAll request.
Methods
(Permalink)
SetPicture (ay: Picture, s: MIME_Type) → nothing
Parameters
-
Picture — ay
The new picture.
-
MIME_Type — s
The MIME type.
Set the room's picture. Clients SHOULD look at the picture
flags before calling this method as the user might not have
permission to set the picture.
A successful return of this method indicates a successful
change in picture, but clients should still listen for changes
to the Picture 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.
- Invalid Argument
Picture is somehow invalid: e.g. unsupported MIME type,
too big, etc.
- Permission Denied
The user is not permitted to perform the requested operation.
Properties
(Permalink)
Picture — (ays)
(Avatar)
Read only
When this property changes, the
org.freedesktop.DBus.Properties.PropertiesChanged
signal is emitted with the new value.
The picture representing this channel.
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 picture, or the empty string if it is not known.
(Permalink)
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)
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 picture was last
modified, or INT_MAX64 if unknown.
(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 Picture property
can be set by the user by calling
SetPicture, 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
SetPicture can still fail
even with this property set to TRUE.
(Permalink)
SupportedMIMETypes — as
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
An array of supported MIME types (e.g. "image/jpeg").
Clients MAY assume that the first type in this array is preferred.
(Permalink)
MinimumHeight — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The minimum height in pixels of the picture, which MAY be 0.
(Permalink)
MinimumWidth — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The minimum width in pixels of the picture, which MAY be 0.
(Permalink)
RecommendedHeight — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The recommended height in pixels of the picture, or 0 if
there is no preferred height.
(Permalink)
RecommendedWidth — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The recommended width in pixels of the picture, or 0 if
there is no preferred width.
(Permalink)
MaximumHeight — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The maximum height in pixels of the picture, or 0 if
there is no limit.
(Permalink)
MaximumWidth — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The maximum width in pixels of the picture, or 0 if
there is no limit.
(Permalink)
MaximumBytes — u
Read only
This property is
immutable which means that it can never
change once the channel has been created. Immutable properties SHOULD
appear in the channel detail list
of
NewChannel
signals.
The maximum size in bytes of the picture, or 0 if
there is no limit.