Folks.Individual – folks Reference Manual

Individual

Object Hierarchy:

Description:

public class Individual : Object, AliasDetails, AvatarDetails, BirthdayDetails, EmailDetails, ExtendedInfo, FavouriteDetails, GenderDetails, GroupDetails, ImDetails, InteractionDetails, LocalIdDetails, LocationDetails, NameDetails, NoteDetails, PresenceDetails, PhoneDetails, PostalAddressDetails, RoleDetails, UrlDetails, WebServiceDetails

A physical person, aggregated from the various Personas the person might have, such as their different IM addresses or vCard entries. An individual must always contain at least one Persona.

When choosing the values of single-valued properties (such as Individual.alias and Individual.avatar; but not multi-valued properties such as Individual.groups and Individual.im_addresses) from the Personas in the individual to present as the values of those properties of the individual, it is guaranteed that if the individual contains a persona from the primary persona store (see IndividualAggregator.primary_store), its property values will be chosen above all others. This means that any changes to property values made through folks (which are normally written to the primary store) will always be used by Folks.Individuals.

No further guarantees are made about the order of preference used for choosing which property values to use for the Folks.Individual, other than that the order may vary between properties, but is guaranteed to be stable for a given property.

Namespace: Folks

Package: folks

Content:

Properties:

public TrustLevel trust_level { get; }
The trust level of the Individual.
public LoadableIcon? avatar { set; get; }
An avatar for the contact.
public PresenceType presence_type { set; get; }
The contact's presence type.
public string presence_status { set; get; }
The contact's detailed presence status.
public string presence_message { set; get; }
The contact's presence message.
public string[] client_types { set; get; }
The contact's client types.
public bool is_user { get; }
Whether the Individual is the user.
public string id { get; }
A unique identifier for the Individual.
public string display_name { get; }
The name of this Individual to display in the UI.
public string alias { set; get; }
An alias for the contact.
public StructuredName? structured_name { set; get; }
The contact name split in its constituent parts.
public string full_name { set; get; }
The full name of the contact.
public string nickname { set; get; }
The nickname of the contact.
public Gender gender { set; get; }
The gender of the contact.
public Set<UrlFieldDetails> urls { set; get; }
The websites of the contact.
public Set<PhoneFieldDetails> phone_numbers { set; get; }
The phone numbers of the contact.
public Set<EmailFieldDetails> email_addresses { set; get; }
The email addresses of the contact.
public Set<RoleFieldDetails> roles { set; get; }
The roles of the contact.
public Set<string> local_ids { set; get; }
The IIDs corresponding to Personas in a backend that we fully trust.
public Location? location { set; get; }
The current location of the contact. Null if the contact’s current location isn’t known, or they’re keeping it private.
public DateTime? birthday { set; get; }
The birthday of the Persona and Individual. This is assumed to be in UTC.
public string? calendar_event_id { set; get; }
The event ID of the birthday event from the source calendar.
public Set<NoteFieldDetails> notes { set; get; }
The notes about the contact.
public Set<PostalAddressFieldDetails> postal_addresses { set; get; }
The postal addresses of the contact.
public bool is_favourite { set; get; }
Whether this Individual is a user-defined favourite.
public Set<string> groups { set; get; }
A set of group IDs for groups containing the member.
public MultiMap<string,ImFieldDetails> im_addresses { set; get; }
A mapping of IM protocol to an (unordered) set of IM addresses.
public MultiMap<string,WebServiceFieldDetails> web_service_addresses { set; get; }
A mapping of web service to an (unordered) set of web service addresses.
public uint im_interaction_count { get; }
The IM interaction associated with a Persona
public DateTime? last_im_interaction_datetime { get; }
public uint call_interaction_count { get; }
The call interaction associated with a Persona
public DateTime? last_call_interaction_datetime { get; }
public Set<Persona> personas { set; get; }
The set of Persona s encapsulated by this Individual.

Creation methods:

public Individual (Set<Persona>? personas)
Create a new Individual.

Methods:

public async void change_avatar (LoadableIcon? avatar) throws PropertyError
public async void change_alias (string alias) throws PropertyError
Change the contact's alias.
public async void change_nickname (string nickname) throws PropertyError
Change the contact's nickname.
public async void change_is_favourite (bool is_favourite) throws PropertyError
Change whether the contact is a user-defined favourite.
public async void change_groups (Set<string> groups) throws PropertyError
Change the contact's groups.
public ExtendedFieldDetails? get_extended_field (string name)
Retrieve the value for an arbitrary field.
public async void change_extended_field (string name, ExtendedFieldDetails value) throws PropertyError
Change the value of an arbitrary field.
public async void remove_extended_field (string name) throws PropertyError
Remove an arbitrary field.
public async void change_group (string group, bool is_member)
Add or remove the Individual from the specified group.
public bool has_anti_link_with_persona (Persona p)
Anti-linked with a persona?
public bool has_anti_link_with_individual (Individual i)
Anti-linked with an individual?

Signals:

public signal void removed (Individual? replacement_individual)
Emitted when the last of the Individual's Personas has been removed.
public signal void personas_changed (Set<Persona> added, Set<Persona> removed)
Emitted when one or more Personas are added to or removed from the Individual. As the parameters are (unordered) sets, the orders of their elements are undefined.