Class
PurpleContactInfo
since: 3.0
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.
Available since: 3.0
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.
since: 3.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.
since: 3.0
purple_contact_info_get_favorite
Gets whether or not info is a favorite or starred contact.
since: 3.0
purple_contact_info_get_menu
Gets a BirbActionMenu that can be used as a context menu for info.
since: 3.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.
since: 3.0
purple_contact_info_matches
This will determine if the alias, display name, or username matches needle.
The id is ignored because generally it is a UUID or hex string which will
give very confusing results to end users.
since: 3.0
purple_contact_info_set_avatar
Sets the avatar for info to avatar. If avatar is NULL an existing
avatar will be removed.
since: 3.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.
since: 3.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.
since: 3.0
Purple.ContactInfo:avatar
The avatar for this contact. This is typically controlled by the protocol and should only be read by others.
since: 3.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.
since: 3.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.
since: 3.0
Purple.ContactInfo:email
The primary email address for the contact. This may also be controlled via a protocol plugin in the event that the protocol makes it available.
since: 3.0
Purple.ContactInfo:favorite
Whether or not the contact info has been marked as a favorite or stared.
since: 3.0
Purple.ContactInfo:name-for-display
The name that the user interface should display for this contact info.
since: 3.0
Purple.ContactInfo:note
A note for this contact. Many protocols will allow you to set a note on a contact and store it server side. This property is where that is kept track of.
since: 3.0
Purple.ContactInfo:phone-number
The primary phone number for the contact. This may also be set via a protocol plugin in the event that the protocol knows it.
since: 3.0
Purple.ContactInfo:presence
The PurplePresence for this contact. This is typically
controlled by the protocol and should only be read by others.
since: 3.0
Purple.ContactInfo:sid
The sid, or secondary id, is an additional identifier field for a contact.
since: 3.0
Purple.ContactInfo:time-zone
The time zone for this contact. This is typically controlled by the protocol and should only be read by others.
since: 3.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.
since: 3.0
Signals
Purple.ContactInfo::populate-menu
Emitted in response to purple_contact_info_get_menu() being called,
so that plugins can add additional items to menu.
since: 3.0
Purple.ContactInfo::presence-changed
This is a propagation of the notify signal from presence. This means
that your callback will be called when anything in the presence changes.
since: 3.0
Signals inherited from GObject (1)
GObject::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.