Class

PurpleContact

Description [src]

final class Purple.Contact : Purple.ContactInfo
{
  /* No available fields */
}

A contact is a concrete representation of a user in that it contains all of the contact information as well as a PurpleAccount to use that contact information with.

Constructors

purple_contact_new

Creates a new PurpleContact.

unstable since: 3.0

Instance methods

purple_contact_compare

Compares contacts a and b.

unstable since: 3.0

purple_contact_create_dm_async

Asks the protocol to create a direct message with contact.

unstable since: 3.0

purple_contact_create_dm_finish

Finishes a previous call to purple_contact_create_dm_async().

unstable since: 3.0

purple_contact_equal

Checks two PurpleContact objects for equality.

unstable since: 3.0

purple_contact_find_dm

This is a wrapper around purple_conversation_manager_find_dm() to make it easier to see if a direct message exists with contact.

unstable since: 3.0

purple_contact_get_account

Gets the PurpleAccount that contact belongs to.

unstable since: 3.0

Methods inherited from PurpleContactInfo (35)

Please see PurpleContactInfo for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Contact:account

The account that this contact belongs to.

unstable since: 3.0

Properties inherited from PurpleContactInfo (17)
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.

unstable 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.

unstable 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.

unstable 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.

unstable 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.

unstable since: 3.0

Purple.ContactInfo:favorite

Whether or not the contact info has been marked as a favorite or stared.

unstable since: 3.0

Purple.ContactInfo:id

The protocol specific id for the contact.

unstable since: 3.0

Purple.ContactInfo:name-for-display

The name that the user interface should display for this contact info.

unstable 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.

unstable since: 3.0

Purple.ContactInfo:permission

The permission level for the contact.

unstable since: 3.0

Purple.ContactInfo:person

The PurplePerson that this contact belongs to.

unstable 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.

unstable 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.

unstable since: 3.0

Purple.ContactInfo:sid

The sid, or secondary id, is an additional identifier field for a contact.

unstable since: 3.0

Purple.ContactInfo:tags

The PurpleTags for this contact.

unstable 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.

unstable 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.

unstable since: 3.0

Signals

Signals inherited from PurpleContactInfo (2)
PurpleContactInfo::populate-menu

Emitted in response to purple_contact_info_get_menu() being called, so that plugins can add additional items to menu.

unstable since: 3.0

PurpleContactInfo::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.

unstable 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.

Class structure

struct PurpleContactClass {
  PurpleContactInfoClass parent_class;
  
}

No description available.

Class members
parent_class: PurpleContactInfoClass

No description available.