summaryrefslogtreecommitdiff
path: root/gdata/services/contacts/gdata-contacts-contact.h
blob: ebc73d3d63e4e62f46aa5a877fabf2868bdde7d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/*
 * GData Client
 * Copyright (C) Philip Withnall 2009, 2010, 2011 <philip@tecnocode.co.uk>
 *
 * GData Client is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * GData Client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GData Client.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GDATA_CONTACTS_CONTACT_H
#define GDATA_CONTACTS_CONTACT_H

#include <glib.h>
#include <glib-object.h>

#include <gdata/gdata-entry.h>
#include <gdata/gd/gdata-gd-name.h>
#include <gdata/gd/gdata-gd-email-address.h>
#include <gdata/gd/gdata-gd-im-address.h>
#include <gdata/gd/gdata-gd-organization.h>
#include <gdata/gd/gdata-gd-phone-number.h>
#include <gdata/gd/gdata-gd-postal-address.h>
#include <gdata/gcontact/gdata-gcontact-calendar.h>
#include <gdata/gcontact/gdata-gcontact-event.h>
#include <gdata/gcontact/gdata-gcontact-external-id.h>
#include <gdata/gcontact/gdata-gcontact-jot.h>
#include <gdata/gcontact/gdata-gcontact-language.h>
#include <gdata/gcontact/gdata-gcontact-relation.h>
#include <gdata/gcontact/gdata-gcontact-website.h>

G_BEGIN_DECLS

/**
 * GDATA_CONTACTS_GENDER_MALE:
 *
 * The contact is male.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_GENDER_MALE "male"

/**
 * GDATA_CONTACTS_GENDER_FEMALE:
 *
 * The contact is female.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_GENDER_FEMALE "female"

/**
 * GDATA_CONTACTS_PRIORITY_LOW:
 *
 * The contact is of low importance.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_PRIORITY_LOW "low"

/**
 * GDATA_CONTACTS_PRIORITY_NORMAL:
 *
 * The contact is of normal importance.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_PRIORITY_NORMAL "normal"

/**
 * GDATA_CONTACTS_PRIORITY_HIGH:
 *
 * The contact is of high importance.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_PRIORITY_HIGH "high"

/**
 * GDATA_CONTACTS_SENSITIVITY_CONFIDENTIAL:
 *
 * The contact's data is confidential.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_SENSITIVITY_CONFIDENTIAL "confidential"

/**
 * GDATA_CONTACTS_SENSITIVITY_NORMAL:
 *
 * The contact's data is of normal sensitivity.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_SENSITIVITY_NORMAL "normal"

/**
 * GDATA_CONTACTS_SENSITIVITY_PERSONAL:
 *
 * The contact's data is personal.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_SENSITIVITY_PERSONAL "personal"

/**
 * GDATA_CONTACTS_SENSITIVITY_PRIVATE:
 *
 * The contact's data is private.
 *
 * Since: 0.7.0
 **/
#define GDATA_CONTACTS_SENSITIVITY_PRIVATE "private"

#define GDATA_TYPE_CONTACTS_CONTACT		(gdata_contacts_contact_get_type ())
#define GDATA_CONTACTS_CONTACT(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), GDATA_TYPE_CONTACTS_CONTACT, GDataContactsContact))
#define GDATA_CONTACTS_CONTACT_CLASS(k)		(G_TYPE_CHECK_CLASS_CAST((k), GDATA_TYPE_CONTACTS_CONTACT, GDataContactsContactClass))
#define GDATA_IS_CONTACTS_CONTACT(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), GDATA_TYPE_CONTACTS_CONTACT))
#define GDATA_IS_CONTACTS_CONTACT_CLASS(k)	(G_TYPE_CHECK_CLASS_TYPE ((k), GDATA_TYPE_CONTACTS_CONTACT))
#define GDATA_CONTACTS_CONTACT_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GDATA_TYPE_CONTACTS_CONTACT, GDataContactsContactClass))

typedef struct _GDataContactsContactPrivate	GDataContactsContactPrivate;

/**
 * GDataContactsContact:
 *
 * All the fields in the #GDataContactsContact structure are private and should never be accessed directly.
 *
 * Since: 0.2.0
 **/
typedef struct {
	GDataEntry parent;
	GDataContactsContactPrivate *priv;
} GDataContactsContact;

/**
 * GDataContactsContactClass:
 *
 * All the fields in the #GDataContactsContactClass structure are private and should never be accessed directly.
 *
 * Since: 0.2.0
 **/
typedef struct {
	/*< private >*/
	GDataEntryClass parent;

	/*< private >*/
	/* Padding for future expansion */
	void (*_g_reserved0) (void);
	void (*_g_reserved1) (void);
} GDataContactsContactClass;

GType gdata_contacts_contact_get_type (void) G_GNUC_CONST;

GDataContactsContact *gdata_contacts_contact_new (const gchar *id) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;

gint64 gdata_contacts_contact_get_edited (GDataContactsContact *self);
gboolean gdata_contacts_contact_is_deleted (GDataContactsContact *self) G_GNUC_PURE;

GDataGDName *gdata_contacts_contact_get_name (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_name (GDataContactsContact *self, GDataGDName *name);

const gchar *gdata_contacts_contact_get_nickname (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_nickname (GDataContactsContact *self, const gchar *nickname);

const gchar *gdata_contacts_contact_get_file_as (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_file_as (GDataContactsContact *self, const gchar *file_as);

gboolean gdata_contacts_contact_get_birthday (GDataContactsContact *self, GDate *birthday) G_GNUC_PURE;
void gdata_contacts_contact_set_birthday (GDataContactsContact *self, GDate *birthday, gboolean birthday_has_year);

const gchar *gdata_contacts_contact_get_billing_information (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_billing_information (GDataContactsContact *self, const gchar *billing_information);

const gchar *gdata_contacts_contact_get_directory_server (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_directory_server (GDataContactsContact *self, const gchar *directory_server);

const gchar *gdata_contacts_contact_get_gender (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_gender (GDataContactsContact *self, const gchar *gender);

const gchar *gdata_contacts_contact_get_initials (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_initials (GDataContactsContact *self, const gchar *initials);

const gchar *gdata_contacts_contact_get_maiden_name (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_maiden_name (GDataContactsContact *self, const gchar *maiden_name);

const gchar *gdata_contacts_contact_get_mileage (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_mileage (GDataContactsContact *self, const gchar *mileage);

const gchar *gdata_contacts_contact_get_occupation (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_occupation (GDataContactsContact *self, const gchar *occupation);

const gchar *gdata_contacts_contact_get_priority (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_priority (GDataContactsContact *self, const gchar *priority);

const gchar *gdata_contacts_contact_get_sensitivity (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_sensitivity (GDataContactsContact *self, const gchar *sensitivity);

const gchar *gdata_contacts_contact_get_short_name (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_short_name (GDataContactsContact *self, const gchar *short_name);

const gchar *gdata_contacts_contact_get_subject (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_subject (GDataContactsContact *self, const gchar *subject);

void gdata_contacts_contact_add_email_address (GDataContactsContact *self, GDataGDEmailAddress *email_address);
GList *gdata_contacts_contact_get_email_addresses (GDataContactsContact *self) G_GNUC_PURE;
GDataGDEmailAddress *gdata_contacts_contact_get_primary_email_address (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_email_addresses (GDataContactsContact *self);

void gdata_contacts_contact_add_im_address (GDataContactsContact *self, GDataGDIMAddress *im_address);
GList *gdata_contacts_contact_get_im_addresses (GDataContactsContact *self) G_GNUC_PURE;
GDataGDIMAddress *gdata_contacts_contact_get_primary_im_address (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_im_addresses (GDataContactsContact *self);

void gdata_contacts_contact_add_phone_number (GDataContactsContact *self, GDataGDPhoneNumber *phone_number);
GList *gdata_contacts_contact_get_phone_numbers (GDataContactsContact *self) G_GNUC_PURE;
GDataGDPhoneNumber *gdata_contacts_contact_get_primary_phone_number (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_phone_numbers (GDataContactsContact *self);

void gdata_contacts_contact_add_postal_address (GDataContactsContact *self, GDataGDPostalAddress *postal_address);
GList *gdata_contacts_contact_get_postal_addresses (GDataContactsContact *self) G_GNUC_PURE;
GDataGDPostalAddress *gdata_contacts_contact_get_primary_postal_address (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_postal_addresses (GDataContactsContact *self);

void gdata_contacts_contact_add_organization (GDataContactsContact *self, GDataGDOrganization *organization);
GList *gdata_contacts_contact_get_organizations (GDataContactsContact *self) G_GNUC_PURE;
GDataGDOrganization *gdata_contacts_contact_get_primary_organization (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_organizations (GDataContactsContact *self);

void gdata_contacts_contact_add_jot (GDataContactsContact *self, GDataGContactJot *jot);
GList *gdata_contacts_contact_get_jots (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_jots (GDataContactsContact *self);

void gdata_contacts_contact_add_relation (GDataContactsContact *self, GDataGContactRelation *relation);
GList *gdata_contacts_contact_get_relations (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_relations (GDataContactsContact *self);

void gdata_contacts_contact_add_website (GDataContactsContact *self, GDataGContactWebsite *website);
GList *gdata_contacts_contact_get_websites (GDataContactsContact *self) G_GNUC_PURE;
GDataGContactWebsite *gdata_contacts_contact_get_primary_website (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_websites (GDataContactsContact *self);

void gdata_contacts_contact_add_event (GDataContactsContact *self, GDataGContactEvent *event);
GList *gdata_contacts_contact_get_events (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_events (GDataContactsContact *self);

void gdata_contacts_contact_add_calendar (GDataContactsContact *self, GDataGContactCalendar *calendar);
GList *gdata_contacts_contact_get_calendars (GDataContactsContact *self) G_GNUC_PURE;
GDataGContactCalendar *gdata_contacts_contact_get_primary_calendar (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_calendars (GDataContactsContact *self);

void gdata_contacts_contact_add_external_id (GDataContactsContact *self, GDataGContactExternalID *external_id);
GList *gdata_contacts_contact_get_external_ids (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_external_ids (GDataContactsContact *self);

void gdata_contacts_contact_add_hobby (GDataContactsContact *self, const gchar *hobby);
GList *gdata_contacts_contact_get_hobbies (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_hobbies (GDataContactsContact *self);

void gdata_contacts_contact_add_language (GDataContactsContact *self, GDataGContactLanguage *language);
GList *gdata_contacts_contact_get_languages (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_remove_all_languages (GDataContactsContact *self);

const gchar *gdata_contacts_contact_get_extended_property (GDataContactsContact *self, const gchar *name) G_GNUC_PURE;
GHashTable *gdata_contacts_contact_get_extended_properties (GDataContactsContact *self) G_GNUC_PURE;
gboolean gdata_contacts_contact_set_extended_property (GDataContactsContact *self, const gchar *name, const gchar *value);

const gchar *gdata_contacts_contact_get_user_defined_field (GDataContactsContact *self, const gchar *name) G_GNUC_PURE;
GHashTable *gdata_contacts_contact_get_user_defined_fields (GDataContactsContact *self) G_GNUC_PURE;
void gdata_contacts_contact_set_user_defined_field (GDataContactsContact *self, const gchar *name, const gchar *value);

void gdata_contacts_contact_add_group (GDataContactsContact *self, const gchar *href);
void gdata_contacts_contact_remove_group (GDataContactsContact *self, const gchar *href);
gboolean gdata_contacts_contact_is_group_deleted (GDataContactsContact *self, const gchar *href) G_GNUC_PURE;
GList *gdata_contacts_contact_get_groups (GDataContactsContact *self) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;

#include <gdata/services/contacts/gdata-contacts-service.h>

const gchar *gdata_contacts_contact_get_photo_etag (GDataContactsContact *self) G_GNUC_PURE;

guint8 *gdata_contacts_contact_get_photo (GDataContactsContact *self, GDataContactsService *service, gsize *length, gchar **content_type,
                                          GCancellable *cancellable, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
void gdata_contacts_contact_get_photo_async (GDataContactsContact *self, GDataContactsService *service, GCancellable *cancellable,
                                             GAsyncReadyCallback callback, gpointer user_data);
guint8 *gdata_contacts_contact_get_photo_finish (GDataContactsContact *self, GAsyncResult *async_result, gsize *length, gchar **content_type,
                                                 GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;

gboolean gdata_contacts_contact_set_photo (GDataContactsContact *self, GDataContactsService *service, const guint8 *data, gsize length,
                                           const gchar *content_type, GCancellable *cancellable, GError **error);
void gdata_contacts_contact_set_photo_async (GDataContactsContact *self, GDataContactsService *service, const guint8 *data, gsize length,
                                             const gchar *content_type, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
gboolean gdata_contacts_contact_set_photo_finish (GDataContactsContact *self, GAsyncResult *async_result, GError **error);

G_END_DECLS

#endif /* !GDATA_CONTACTS_CONTACT_H */