[Telepathy] Avatar interface proposal

Andre Magalhaes andrunko at gmail.com
Wed Jun 7 12:35:57 PDT 2006


Hi all,

So lets start the cooperation :).
After some discussion on #telepathy channel with other developers, i
came up with a interface for retrieving avatar images. Here is the
first version of it.
Please comment on it. I am not sure if the GetAvatar should have a
avatar_id as a parameter, as it's clearly not necessary.


org.freedesktop.Telepathy.Connection.Interface.Avatar

    An interface for requesting a contact avatar on a given
    connection.

Methods:
GetAvatarId (u: contact ) -> u: avatar_id

        Get the avatar id for a given contact. This id should be used
to check if
        the avatar has been updated.

        Parameters:
        contact - an integer handle for the contact to request the avatar for

        Returns:
        SHA1 hash of the avatar image data itself

        Possible Errors:
        Disconnected, NetworkError, InvalidHandle, PermissionDenied,
NotAvailable

GetAvatar ( u: contact, u: avatar_id ) -> s: avatar

        Get the avatar for a given contact.

        Parameters:
        contact - an integer handle for the contact to request the avatar for
        avatar_id - SHA1 hash of the avatar image data itself

        Returns:
        A Base64 encoded avatar image

        Possible Errors:
        Disconnected, NetworkError, InvalidHandle, PermissionDenied,
NotAvailable

Signals:
AvatarUpdated ( u: contact, u: new_avatar_id )

        Emitted when the avatar for the user has been updated. Note
that this signal will only be emitted when the avatar has changed in
the Connection lifetime. To user the contact new avatar use GetAvatar
with the new avatar id as argument.

        Parameters:
        contact - an integer handle of the contact ID on the server
        new_avatar_id - SHA1 hash of the new avatar image data itself


BR
Andrunko


More information about the Telepathy mailing list