Protocol.I.Avatars — Telepathy D-Bus Interface Specification

# Interface Protocol.Interface.Avatars

Interface Index (Compact) | Summary | Description | Properties

### Properties

SupportedAvatarMIMETypes | as | Read only | Immutable |
MinimumAvatarHeight | u | Read only | Immutable |
MinimumAvatarWidth | u | Read only | Immutable |
RecommendedAvatarHeight | u | Read only | Immutable |
RecommendedAvatarWidth | u | Read only | Immutable |
MaximumAvatarHeight | u | Read only | Immutable |
MaximumAvatarWidth | u | Read only | Immutable |
MaximumAvatarBytes | u | Read only | Immutable |

Added in 0.21.5. (as stable API)
Objects implementing this interface must also implement:

- org.freedesktop.Telepathy.Protocol

### Description

An interface for protocols where it might be possible to set the user's avatar, and the expected size limits and supported MIME types are known before connecting.

##### Rationale:

If the avatar requirements cannot be discovered while offline, it's impossible to avoid setting the Account's Avatar property to an unsupported avatar.

Each property on this interface SHOULD be cached in the `.manager` file, using a key of the same name as the property in the `[Protocol proto]` group. All properties are encoded in ASCII decimal in the obvious way, except for SupportedAvatarMIMETypes which is encoded as a sequence of strings each followed by a semicolon (as for the "localestrings" type in the Desktop Entry Specification).

For instance, an XMPP connection manager might have this `.manager` file:

    [Protocol jabber]
    Interfaces=org.freedesktop.Telepathy.Protocol.Interface.Avatars;
    param-account=s required
    param-password=s required
    SupportedAvatarMIMETypes=image/png;image/jpeg;image/gif;
    MinimumAvatarHeight=32
    RecommendedAvatarHeight=64
    MaximumAvatarHeight=96
    MinimumAvatarWidth=32
    RecommendedAvatarWidth=64
    MaximumAvatarWidth=96
    MaximumAvatarBytes=8192

# Properties

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

## SupportedAvatarMIMETypes — as

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.SupportedAvatarMIMETypes property on connections to this protocol.
(Permalink)

## MinimumAvatarHeight — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.MinimumAvatarHeight property on connections to this protocol.
(Permalink)

## MinimumAvatarWidth — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.MinimumAvatarWidth property on connections to this protocol.
(Permalink)

## RecommendedAvatarHeight — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.RecommendedAvatarHeight property on connections to this protocol.
(Permalink)

## RecommendedAvatarWidth — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.RecommendedAvatarWidth property on connections to this protocol.
(Permalink)

## MaximumAvatarHeight — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.MaximumAvatarHeight property on connections to this protocol.
(Permalink)

## MaximumAvatarWidth — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.MaximumAvatarWidth property on connections to this protocol.
(Permalink)

## MaximumAvatarBytes — u

Read only
This property is immutable which means that it can never change.
The expected value of the Connection.Interface.Avatars.MaximumAvatarBytes property on connections to this protocol.