Add documentation support and stub documentation to Folks
[platform/upstream/folks.git] / 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, Alias, Avatar, Capabilities,
31        Presence
32 {
33   /* interface Alias */
34   public abstract string alias { get; set; }
35
36   /* interface Avatar */
37   public abstract File avatar { get; set; }
38
39   /* interface Capabilities */
40   public abstract CapabilitiesFlags capabilities { get; set; }
41
42   /* interface Presence */
43   public abstract Folks.PresenceType presence_type { get; set; }
44   public abstract string presence_message { get; set; }
45
46   /* internal ID */
47   public string iid { get; construct; }
48   /* universal ID (eg, "foo@xmpp.example.org") */
49   public string uid { get; construct; }
50
51   public PersonaStore store { get; construct; }
52 }