folks

---

Description:

Content:

Namespaces:

• Folks -

Interfaces:

• AliasDetails - Interface for classes which represent aliasable contacts, such as Persona and Individual.
• AvatarDetails - Interface for classes which represent contacts which have an avatar (pictorial representation), such as Persona and Individual.
• BirthdayDetails - This interface contains the birth date of a Persona and Individual
• EmailDetails - Interface for classes that have email addresses, such as Persona and Individual.
• FavouriteDetails - Interface exposing a Persona's or Individual's user-defined status as a favourite.
• GenderDetails - Interface for specifying the gender of a contact.
• GroupDetails - Interface for Personas or Individuals which can be grouped into sets of similar objects.
• ImDetails - IM addresses exposed by an object implementing PresenceDetails.
• LocalIdDetails - This interface represents the list of Persona.iids corresponding to Personas from backends with write support so that they can be linked.
• NameDetails - Interface for classes which represent contacts with names, such as Persona and Individual.
• NoteDetails - This interface represents the list of notes associated to a Persona and Individual.
• PhoneDetails - Interface for classes that can provide a phone number, such as Persona and Individual.
• PostalAddressDetails - Interface for classes that can provide postal addresses, such as Persona and Individual.
• PresenceDetails - Interface exposing a Persona's or Individual's presence; their current availability, such as for chatting.
• RoleDetails - This interfaces represents the list of roles a Persona and Individual might have.
• UrlDetails - Associates a list of URLs with a contact.
• WebServiceDetails - Web service contact details.

Classes:

• AbstractFieldDetails - Object representing any type of value that can have some vCard-like parameters associated with it.
• AvatarCache - A singleton persistent cache object for avatars used across backends in folks. Avatars may be added to the cache, and referred to by a persistent URI from that point onwards.
• BackendStore - Responsible for backend loading.
• Backend - A single backend to libfolks, such as Telepathy or evolution-data-server. Each backend provides Personas which are aggregated to form Individuals.
• Debug - Manage debug output and status reporting for all folks objects. All GLib debug logging calls are passed through a log handler in this class, which allows debug domains to be outputted according to whether they've been enabled by being passed to Debug.dup.
• EmailFieldDetails - Object representing a email address that can have some parameters associated with it.
• ImFieldDetails - Object representing an IM address value that can have some parameters associated with it.
• IndividualAggregator - Stores Individuals which have been created through aggregation of all the Personas provided by the various Backends.
• Individual - A physical person, aggregated from the various Personas the person might have, such as their different IM addresses or vCard entries.
• StructuredName - Object for a full name split in its constituent parts (given name, family name, etc.). This structure corresponds to the "N" field in VCards. The parts of the name are never null, an empty string indicates that a property is not set.
• NoteFieldDetails - Object representing a note that can have some parameters associated with it.
• ObjectCache - A generic abstract cache for sets of objects. This can be used by subclasses to implement caching of homogeneous sets of objects. Subclasses simply have to implement serialisation and deserialisation of the objects to and from GLib.Variants.
• PersonaStore - A store for Personas.
• Persona - Represents a "shard" of a person from a single source (a single Backend), such as an XMPP contact from Telepathy or a vCard contact from evolution-data-server.
• PhoneFieldDetails - Object representing a phone number that can have some parameters associated with it.
• PostalAddress - Object representing a postal mail address. The components of the address are never null, an empty string indicates that a property is not set.
• PostalAddressFieldDetails - Object representing a PostalAddress value that can have some parameters associated with it.
• PotentialMatch - This class provides functionality to explore a potential match between two individuals.
• Role - This interface represents the role a Persona and Individual have in a given Organisation.
• RoleFieldDetails - Object representing details of a contact in an organisation which can have some parameters associated with it.
• UrlFieldDetails - Object representing a URL that can have some parameters associated with it.
• Utils - Utility functions to simplify common patterns in Folks client code.
• WebServiceFieldDetails - Object representing a web service contact that can have some parameters associated with it.

Enums:

• Gender - The gender of a contact
• TrustLevel - Trust level for an Individual for use in the UI.
• PersonaStoreTrust - Trust level for a PersonaStore's Personas for linking purposes.
• PersonaDetail - Definition of the available fields to be looked up with PersonaStore.detail_key.
• MatchResult - Likely-ness of a potential match.
• PresenceType - The possible presence states an object implementing PresenceDetails could be in.
• MaybeBool - A 'boolean' type that has a distinct 'unset' state.

Error domains:

• ImDetailsError - Errors related to IM addresses and IM address handling.
• IndividualAggregatorError - Errors from IndividualAggregators.
• PersonaStoreError - Errors from PersonaStores.
• PropertyError - Errors which can be thrown when asynchronously setting a property of a Persona using a setter method defined on an interface such as AliasDetails.