Edsf.Persona – folks-eds Reference Manual

# Persona

## Object Hierarchy:

## Description:

public class Persona : Persona, AntiLinkable, AvatarDetails, BirthdayDetails, EmailDetails, ExtendedInfo, FavouriteDetails, GenderDetails, GroupDetails, ImDetails, LocalIdDetails, LocationDetails, NameDetails, NoteDetails, PhoneDetails, RoleDetails, UrlDetails, PostalAddressDetails, WebServiceDetails

A persona subclass which represents a single EDS contact.

Each Edsf.Persona instance represents a single EDS E.Contact. When the contact is modified (either by this folks client, or a different client), the Edsf.Persona remains the same, but is assigned a new E.Contact. It then updates its properties from this new contact.

Namespace: Edsf
Package: folks-eds

## Content:

### Constants:

- public const (unowned string)[] address_fields
  vCard field names for postal addresses.
- public const (unowned string)[] email_fields
  vCard field names for e-mail addresses.
- public const string folks_field_attribute_name
  Name of folks’ custom parameter indicating automatic fields
- public const string gender_attribute_name
  The vCard attribute used to specify a Contact's gender
- public const string gender_female
  The value used to define the female gender for the X-GENDER vCard property.
- public const string gender_male
  The value used to define the male gender for the X-GENDER vCard property.
- public const (unowned string)[] phone_fields
  vCard field names for telephone numbers.
- public const (unowned string)[] url_properties
  vCard field names for miscellaneous URIs.

### Properties:

- public Set<string> anti_links { get; set; }
- public LoadableIcon? avatar { get; set; }
  An avatar for the Persona.
- public DateTime? birthday { get; set; }
- public string? calendar_event_id { get; set; }
- public Contact contact { get; construct; }
  The e-d-s contact represented by this Persona
- public string contact_id { get; construct; }
  The e-d-s contact uid
- public Set<EmailFieldDetails> email_addresses { get; set; }
- public string full_name { get; set; }
- public Gender gender { get; set; }
- public Set<string> groups { get; set; }
- public MultiMap<string,ImFieldDetails> im_addresses { get; set; }
- public bool in_google_personal_group { get; set; }
  Whether this contact is in the “My Contacts” section of the user’s address book, rather than the “Other” section.
- public bool is_favourite { get; set; }
  Whether this contact is a user-defined favourite.
- public override string[] linkable_properties { get; }
- public Set<string> local_ids { get; set; }
  IDs used to link Edsf.Personas.
- public Location? location { get; set; }
- public string nickname { get; set; }
- public Set<NoteFieldDetails> notes { get; set; }
- public Set<PhoneFieldDetails> phone_numbers { get; set; }
- public Set<PostalAddressFieldDetails> postal_addresses { get; set; }
  The postal addresses of the contact.
- public Set<RoleFieldDetails> roles { get; set; }
- public StructuredName? structured_name { get; set; }
- public Set<string>? system_groups { get; set; }
  The complete set of system group identifiers the contact belongs to. See Persona.change_system_groups for details.
- public Set<UrlFieldDetails> urls { get; set; }
- public MultiMap<string,WebServiceFieldDetails> web_service_addresses { get; set; }
- public override string[] writeable_properties { get; }

### Creation methods:

- public Persona (PersonaStore store, Contact contact)
  Create a new persona.

### Methods:

- public async void change_anti_links (Set<string> anti_links) throws PropertyError
- public async void change_avatar (LoadableIcon? avatar) throws PropertyError
- public async void change_birthday (DateTime? bday) throws PropertyError
- public async void change_email_addresses (Set<EmailFieldDetails> email_addresses) throws PropertyError
- public async void change_extended_field (string name, ExtendedFieldDetails value) throws PropertyError
- public async void change_full_name (string full_name) throws PropertyError
- public async void change_gender (Gender gender) throws PropertyError
- public async void change_group (string group, bool is_member) throws Error
- public async void change_groups (Set<string> groups) throws PropertyError
- public async void change_im_addresses (MultiMap<string,ImFieldDetails> im_addresses) throws PropertyError
- public async void change_in_google_personal_group (bool in_personal) throws PropertyError
  Change whether this contact belongs to the personal group or not.
- public async void change_is_favourite (bool is_favourite) throws PropertyError
- public async void change_local_ids (Set<string> local_ids) throws PropertyError
- public async void change_location (Location? location) throws PropertyError
- public async void change_nickname (string nickname) throws PropertyError
- public async void change_notes (Set<NoteFieldDetails> notes) throws PropertyError
- public async void change_phone_numbers (Set<PhoneFieldDetails> phone_numbers) throws PropertyError
- public async void change_postal_addresses (Set<PostalAddressFieldDetails> postal_addresses) throws PropertyError
- public async void change_roles (Set<RoleFieldDetails> roles) throws PropertyError
- public async void change_structured_name (StructuredName? structured_name) throws PropertyError
- public async void change_system_groups (Set<string> system_groups) throws PropertyError
  Change the contact's system groups.
- public async void change_urls (Set<UrlFieldDetails> urls) throws PropertyError
- public async void change_web_service_addresses (MultiMap<string,WebServiceFieldDetails> web_service_addresses) throws PropertyError
- public ExtendedFieldDetails? get_extended_field (string name)
- public override void linkable_property_to_links (string prop_name, LinkablePropertyCallback callback)
- public async void remove_extended_field (string name) throws PropertyError

### Inherited Members:

All known members inherited from class Folks.Persona

- LinkablePropertyCallback
- build_uid
- display_id
- iid

- individual
- is_user
- linkable_properties
- linkable_property_to_links

- split_uid
- store
- uid
- writeable_properties

All known members inherited from class GLib.Object

- @get
- @new
- @ref
- @set
- add_toggle_ref
- add_weak_pointer
- bind_property
- connect
- constructed
- disconnect
- dispose
- dup_data
- dup_qdata
- force_floating
- freeze_notify
- get_class
- get_data

- get_property
- get_qdata
- get_type
- getv
- interface_find_property
- interface_install_property
- interface_list_properties
- is_floating
- new_valist
- new_with_properties
- newv
- notify
- notify_property
- ref_count
- ref_sink
- remove_toggle_ref
- remove_weak_pointer

- replace_data
- replace_qdata
- set_data
- set_data_full
- set_property
- set_qdata
- set_qdata_full
- set_valist
- setv
- steal_data
- steal_qdata
- thaw_notify
- unref
- watch_closure
- weak_ref
- weak_unref

All known members inherited from interface Folks.AntiLinkable

- add_anti_links
- add_global_anti_link
- anti_links

- change_anti_links
- has_anti_link_with_persona
- has_global_anti_link

- remove_anti_links
- remove_global_anti_link

All known members inherited from interface Folks.AvatarDetails

- avatar

- change_avatar

All known members inherited from interface Folks.BirthdayDetails

- birthday
- calendar_event_id

- change_birthday

- change_calendar_event_id

All known members inherited from interface Folks.EmailDetails

- change_email_addresses

- email_addresses

All known members inherited from interface Folks.ExtendedInfo

- change_extended_field

- get_extended_field

- remove_extended_field

All known members inherited from interface Folks.FavouriteDetails

- change_is_favourite

- is_favourite

All known members inherited from interface Folks.GenderDetails

- change_gender

- gender

All known members inherited from interface Folks.GroupDetails

- change_group
- change_groups

- group_changed

- groups

All known members inherited from interface Folks.ImDetails

- change_im_addresses

- im_addresses

- normalise_im_address

All known members inherited from interface Folks.LocalIdDetails

- change_local_ids

- local_ids

All known members inherited from interface Folks.LocationDetails

- change_location

- location

All known members inherited from interface Folks.NameDetails

- change_full_name
- change_nickname

- change_structured_name
- full_name

- nickname
- structured_name

All known members inherited from interface Folks.NoteDetails

- change_notes

- notes

All known members inherited from interface Folks.PhoneDetails

- change_phone_numbers

- phone_numbers

All known members inherited from interface Folks.RoleDetails

- change_roles

- roles

All known members inherited from interface Folks.UrlDetails

- change_urls

- urls

All known members inherited from interface Folks.PostalAddressDetails

- change_postal_addresses

- postal_addresses

All known members inherited from interface Folks.WebServiceDetails

- change_web_service_addresses

- web_service_addresses