Class
PurpleContactInfo
Description [src]
class Purple.ContactInfo : GObject.Object {
parent_instance: GObject
}
The information about a contact. This information is used everywhere you need to refer to a user. Be it a chat, an direct message, a file transfer, etc.
Instance methods
purple_contact_info_get_color
Gets the color that should be used to render this contact info. This is a RGB hex code in a string format.
Available since: 3.0.0
purple_contact_info_get_display_name
Gets the display name for info
. The display name is typically set by the
contact and is handled by the protocol plugin.
Available since: 3.0.0
purple_contact_info_get_name_for_display
Gets the name that should be displayed for info
. See
PurpleContactInfo:name-for-display
for more information.
Available since: 3.0.0
purple_contact_info_get_permission
Gets the PurpleContactInfoPermission
for info
.
Available since: 3.0.0
purple_contact_info_set_avatar
Sets the avatar for info
to avatar
. If avatar
is NULL
an existing
avatar will be removed.
Available since: 3.0.0
purple_contact_info_set_color
Sets the color to use when rendering info
to color
.
Available since: 3.0.0
purple_contact_info_set_display_name
Sets the display name of info
to display_name
.
Available since: 3.0.0
purple_contact_info_set_id
Sets the identifier of info
to id
. Note, this should be used rarely if
at all. The main intent of this, is for protocols to update the id of an
an account when it is connected if the id is missing.
Available since: 3.0.0
purple_contact_info_set_permission
Sets the permission of info
to permission
.
Available since: 3.0.0
purple_contact_info_set_person
Sets the person that info
belongs to to person
.
Available since: 3.0.0
Properties
Purple.ContactInfo:alias
The alias for this contact. This is controlled by the libpurple user and may be used by the protocol if it allows for aliasing.
Available since: 3.0.0
Purple.ContactInfo:avatar
The avatar for this contact. This is typically controlled by the protocol and should only be read by others.
Available since: 3.0.0
Purple.ContactInfo:color
The color for this contact. This is an RGB hex code that user interfaces can use when rendering the contact. This may also be controlled via a protocol plugin in the event that the protocol allows people to set a highlight/branding color.
Available since: 3.0.0
Purple.ContactInfo:display-name
The display name for this contact. This is generally set by the person the contact is representing and controlled via the protocol plugin.
Available since: 3.0.0
Purple.ContactInfo:name-for-display
The name that the user interface should display for this contact info.
Available since: 3.0.0
Purple.ContactInfo:presence
The PurplePresence
for this contact. This is typically
controlled by the protocol and should only be read by others.
Available since: 3.0.0
Purple.ContactInfo:username
The username for this contact. In rare cases this can change, like when a user changes their “nick” on IRC which is their user name.
Available since: 3.0.0
Signals
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.