Methods
GetAliasFlags | () | → | u: Alias_Flags | |
RequestAliases | (au: Contacts) | → | as: Aliases | |
GetAliases | (au: Contacts) | → | a{us}: Aliases | |
SetAliases | (a{us}: Aliases) | → | nothing |
Signals
AliasesChanged | (a(us): Aliases) |
Contact Attributes
org.freedesktop.Telepathy.Connection.Interface.Aliasing/alias | s |
Types
Connection_Alias_Flags | Flags | u | |
Alias_Map | Mapping | a{us} | |
Alias_Pair | Struct | (us) |
Description
An interface on connections to support protocols where contacts have an alias which they can change at will. Provides a method for the user to set their own alias, and a signal which should be emitted when a contact's alias is changed or first discovered.
On connections where the user is allowed to set aliases for contacts and store them on the server, the GetAliasFlags method will have the CONNECTION_ALIAS_FLAG_USER_SET flag set, and the SetAliases method may be called on contact handles other than the user themselves.
Aliases are intended to be used as the main displayed name for the contact, where available.
Methods
GetAliasFlags () → u: Alias_Flags
Returns
- Alias_Flags — u (Connection_Alias_Flags)
Possible Errors
- Disconnected
RequestAliases (au: Contacts) → as: Aliases
Parameters
- Contacts — au (Contact_Handle_List)
Returns
- Aliases — as
Possible Errors
- Disconnected
- Network Error
- Not Available
- Invalid Handle
GetAliases (au: Contacts) → a{us}: Aliases
Parameters
- Contacts — au (Contact_Handle_List)
Returns
- Aliases — a{us} (Alias_Map)
Possible Errors
- Disconnected
- Invalid Handle
SetAliases (a{us}: Aliases) → nothing
Parameters
- Aliases — a{us} (Alias_Map)
Possible Errors
- Disconnected
- Network Error
- Not Available
- Invalid Argument
- Permission Denied
Signals
AliasesChanged (a(us): Aliases)
Parameters
- Aliases — a(us) (Alias_Pair_List)
- the handle representing the contact
- the new alias
Contact Attributes
org.freedesktop.Telepathy.Connection.Interface.Aliasing/alias — s
The same string that would be returned by GetAliases (always present with some value, possibly the same as Connection/contact-id, if information from the Aliasing interface was requested)
Types
Connection_Alias_Flags — u
- User_Set (1)
The aliases of contacts on this connection may be changed by the user of the service, not just by the contacts themselves. This is the case on Jabber, for instance.
It is possible that aliases can be changed by the contacts too - which alias takes precedence is not defined by this specification, and depends on the server and/or connection manager implementation.
This flag only applies to the aliases of "globally valid" contact handles. At this time, clients should not expect to be able to change the aliases corresponding to any channel-specific handles. If this becomes possible in future, a new flag will be defined.
Alias_Map — a{us}
- Handle — u (Contact_Handle)
- Alias — s
Alias_Pair — (us)
- Handle — u (Contact_Handle)
- Alias — s