FolksDummy.FullPersona – folks-dummy Reference Manual

FullPersona

Object Hierarchy:

Description:

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

A persona subclass representing a single ‘full’ contact.

This mocks up a ‘full’ persona which implements all the available property interfaces provided by libfolks. This is in contrast with FolksDummy.Persona, which provides a base class implementing none of libfolks’ interfaces.

The full dummy persona can be used to simulate a persona from most libfolks backends, if writing a custom FolksDummy.Persona subclass is not an option.

There are two sides to this class’ interface: the normal methods required by the libfolks ‘details’ interfaces, such as Folks.GenderDetails.change_gender, and the backend methods which should be called by test driver code to simulate changes in the backing store providing this persona, such as FullPersona.update_gender. For example, test driver code should call FullPersona.update_nickname to simulate the user editing a contact’s nickname in an online address book which is being exposed to libfolks. The update_, register_ and unregister_ prefixes are commonly used for backend methods.

The API in FolksDummy is unstable and may change wildly. It is designed mostly for use by libfolks unit tests.

Since:

0.9.7

Namespace: FolksDummy

Package: folks-dummy

Content:

Properties:

public MultiMap<string,WebServiceFieldDetails> web_service_addresses { set; get; }
public Set<string> local_ids { set; get; }
public Set<PostalAddressFieldDetails> postal_addresses { set; get; }
public Set<PhoneFieldDetails> phone_numbers { set; get; }
public Set<EmailFieldDetails> email_addresses { set; get; }
public Set<NoteFieldDetails> notes { set; get; }
public LoadableIcon? avatar { set; get; }
public StructuredName? structured_name { set; get; }
public string full_name { set; get; }
public string nickname { set; get; }
public Gender gender { set; get; }
public Set<UrlFieldDetails> urls { set; get; }
public MultiMap<string,ImFieldDetails> im_addresses { set; get; }
public Set<string> groups { set; get; }
public string? calendar_event_id { set; get; }
public DateTime? birthday { set; get; }
public Set<RoleFieldDetails> roles { set; get; }
public bool is_favourite { set; get; }
Whether this contact is a user-defined favourite.
public Set<string> anti_links { set; get; }

Creation methods:

public FullPersona (PersonaStore store, string contact_id, bool is_user = false, string[] linkable_properties = new string[0] {})
Create a new ‘full’ persona.

Methods:

public async void change_web_service_addresses (MultiMap<string,WebServiceFieldDetails> web_service_addresses) throws PropertyError
public async void change_local_ids (Set<string> local_ids) throws PropertyError
public async void change_postal_addresses (Set<PostalAddressFieldDetails> postal_addresses) throws PropertyError
public async void change_phone_numbers (Set<PhoneFieldDetails> phone_numbers) throws PropertyError
public async void change_email_addresses (Set<EmailFieldDetails> email_addresses) throws PropertyError
public async void change_notes (Set<NoteFieldDetails> notes) throws PropertyError
public async void change_avatar (LoadableIcon? avatar) throws PropertyError
public async void change_structured_name (StructuredName? structured_name) throws PropertyError
public async void change_full_name (string full_name) throws PropertyError
public async void change_nickname (string nickname) throws PropertyError
public async void change_gender (Gender gender) throws PropertyError
public async void change_urls (Set<UrlFieldDetails> urls) throws PropertyError
public async void change_im_addresses (MultiMap<string,ImFieldDetails> im_addresses) 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_calendar_event_id (string? calendar_event_id) throws PropertyError
public async void change_birthday (DateTime? bday) throws PropertyError
public async void change_roles (Set<RoleFieldDetails> roles) throws PropertyError
public async void change_is_favourite (bool is_favourite) throws PropertyError
public async void change_anti_links (Set<string> anti_links) throws PropertyError
public void update_gender (Gender gender)
Update persona's gender.
public void update_calendar_event_id (string? calendar_event_id)
Update persona's birthday calendar event ID.
public void update_birthday (DateTime? birthday)
Update persona's birthday.
public void update_roles (Set<RoleFieldDetails> roles)
Update persona's roles.
public void update_groups (Set<string> groups)
Update persona's groups.
public void update_web_service_addresses (MultiMap<string,WebServiceFieldDetails> web_service_addresses)
Update persona's web service addresses.
public void update_email_addresses (Set<EmailFieldDetails> email_addresses)
Update persona's e-mail addresses.
public void update_notes (Set<NoteFieldDetails> notes)
Update persona's notes.
public void update_full_name (string full_name)
Update persona's full name.
public void update_nickname (string nickname)
Update persona's nickname.
public void update_structured_name (StructuredName? structured_name)
Update persona's structured name.
public void update_avatar (LoadableIcon? avatar)
Update persona's avatar.
public void update_urls (Set<UrlFieldDetails> urls)
Update persona's URIs.
public void update_im_addresses (MultiMap<string,ImFieldDetails> im_addresses)
Update persona's IM addresses.
public void update_phone_numbers (Set<PhoneFieldDetails> phone_numbers)
Update persona's phone numbers.
public void update_postal_addresses (Set<PostalAddressFieldDetails> postal_addresses)
Update persona's postal addresses.
public void update_local_ids (Set<string> local_ids)
Update persona's local IDs.
public void update_is_favourite (bool is_favourite)
Update persona's status as a favourite.
public void update_anti_links (Set<string> anti_links)
Update persona's anti-links.

Inherited Members:

All known members inherited from class FolksDummy.Persona

update_linkable_properties

All known members inherited from class Folks.Persona

display_id
iid
individual
is_user

linkable_properties
store
uid
writeable_properties

LinkablePropertyCallback
build_uid
split_uid
linkable_property_to_links

All known members inherited from class GLib.Object

@new
newv
new_valist
get_type
get_class
@ref
unref
ref_sink
weak_ref
weak_unref
add_weak_pointer
remove_weak_pointer

@get
@set
get_property
set_property
get_data
set_data
set_data_full
steal_data
get_qdata
set_qdata
set_qdata_full
steal_qdata

freeze_notify
thaw_notify
dispose
constructed
notify_property
connect
disconnect
add_toggle_ref
remove_toggle_ref
bind_property
notify
ref_count

All known members inherited from interface Folks.AntiLinkable

anti_links
add_anti_links
add_global_anti_link

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

email_addresses

change_email_addresses

All known members inherited from interface Folks.FavouriteDetails

is_favourite

change_is_favourite

All known members inherited from interface Folks.GenderDetails

gender

change_gender

All known members inherited from interface Folks.GroupDetails

groups
change_group

change_groups

group_changed

All known members inherited from interface Folks.ImDetails

im_addresses

normalise_im_address

change_im_addresses

All known members inherited from interface Folks.LocalIdDetails

local_ids

change_local_ids

All known members inherited from interface Folks.NameDetails

full_name
nickname

structured_name
change_full_name

change_nickname
change_structured_name

All known members inherited from interface Folks.NoteDetails

notes

change_notes

All known members inherited from interface Folks.PhoneDetails

phone_numbers

change_phone_numbers

All known members inherited from interface Folks.RoleDetails

roles

change_roles

All known members inherited from interface Folks.UrlDetails

urls

change_urls

All known members inherited from interface Folks.PostalAddressDetails

postal_addresses

change_postal_addresses

All known members inherited from interface Folks.WebServiceDetails

web_service_addresses

change_web_service_addresses

Generated by Valadoc