folks/persona.vala

   1 /*
   2  * Copyright (C) 2010 Collabora Ltd.
   3  *
   4  * This library is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation, either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Authors:
  18  *       Travis Reitter <travis.reitter@collabora.co.uk>
  19  */
  20
  21 using GLib;
  22 using Folks;
  23
  24 /**
  25  * Represents a "shard" of a person from a single source (a single
  26  * {@link Backend}), such as an XMPP contact from Telepathy or a vCard contact
  27  * from evolution-data-server. All the personas belonging to one physical person
  28  * are aggregated to form a single {@link Individual} representing that person.
  29  */
  30 public abstract class Folks.Persona : Object
  31 {
  32   /**
  33    * The internal ID used to represent the Persona within its {@link Backend}.
  34    *
  35    * This should not be used by client code.
  36    */
  37   public string iid { get; construct; }
  38
  39   /**
  40    * The universal ID used to represent the Persona outside its {@link Backend}.
  41    *
  42    * For example: `foo@@xmpp.example.org`.
  43    *
  44    * This is the canonical way to refer to any Persona. It is guaranteed to be
  45    * unique within the Persona's {@link PersonaStore}.
  46    */
  47   public string uid { get; construct; }
  48
  49   /**
  50    * The {@link PersonaStore} which contains this Persona.
  51    */
  52   public weak PersonaStore store { get; construct; }
  53
  54   /**
  55    * The names of the properties of this Persona which are linkable.
  56    *
  57    * If a property name is in this list, and the Persona is from a
  58    * {@link PersonaStore} whose trust level is {@link PersonaStoreTrust.FULL},
  59    * the {@link IndividualAggregator} should be able to reliably use the value
  60    * of the property from a given Persona instance to link the Persona with
  61    * other Personas and form {@link Individual}s.
  62    *
  63    * Note that {@link Persona.uid} is always implicitly a member of this list,
  64    * and doesn't need to be added explicitly.
  65    *
  66    * This list will have no effect if the Persona's {@link PersonaStore} trust
  67    * level is not {@link PersonaStoreTrust.FULL}.
  68    */
  69   public string[] linkable_properties { get; protected set; }
  70 }