folks/aliasable.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
  23 /**
  24  * Interface for classes which represent aliasable contacts, such as
  25  * {@link Persona} and {@link Individual}.
  26  */
  27 public interface Folks.Aliasable : Object
  28 {
  29   /**
  30    * An alias for the contact.
  31    *
  32    * An alias is a user-given name, to be used in UIs as the sole way to
  33    * represent the contact to the user.
  34    */
  35   public abstract string alias { get; set; }
  36 }