summaryrefslogtreecommitdiff
path: root/src/libedataserver/e-gdata-session.h
blob: c87f8f596ecb830b9245378a755ad152607b8bca (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * SPDX-FileCopyrightText: (C) 2022 Red Hat (www.redhat.com)
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#if !defined (__LIBEDATASERVER_H_INSIDE__) && !defined (LIBEDATASERVER_COMPILATION)
#error "Only <libedataserver/libedataserver.h> should be included directly."
#endif

#ifndef E_GDATA_SESSION_H
#define E_GDATA_SESSION_H

#include <json-glib/json-glib.h>
#include <libedataserver/e-gdata-query.h>
#include <libedataserver/e-soup-session.h>

/* Standard GObject macros */
#define E_TYPE_GDATA_SESSION \
	(e_gdata_session_get_type ())
#define E_GDATA_SESSION(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST \
	((obj), E_TYPE_GDATA_SESSION, EGDataSession))
#define E_GDATA_SESSION_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_CAST \
	((cls), E_TYPE_GDATA_SESSION, EGDataSessionClass))
#define E_IS_GDATA_SESSION(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE \
	((obj), E_TYPE_GDATA_SESSION))
#define E_IS_GDATA_SESSION_CLASS(cls) \
	(G_TYPE_CHECK_CLASS_TYPE \
	((cls), E_TYPE_GDATA_SESSION))
#define E_GDATA_SESSION_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS \
	((obj), E_TYPE_GDATA_SESSION, EGDataSessionClass))

G_BEGIN_DECLS

typedef struct _EGDataSession EGDataSession;
typedef struct _EGDataSessionClass EGDataSessionClass;
typedef struct _EGDataSessionPrivate EGDataSessionPrivate;

/**
 * EGDataObjectCallback:
 * @gdata: an #EGDataSession
 * @object: a #JSonObject with received content
 * @user_data: user data passed to the call
 *
 * Callback used to traverse response from the server, which is
 * an array.
 *
 * Returns: whether the traverse can continue
 *
 * Since: 3.46
 **/
typedef gboolean (*EGDataObjectCallback) (EGDataSession *gdata,
					  JsonObject *object,
					  gpointer user_data);

/**
 * EGDataSession:
 *
 * Contains only private data that should be read and manipulated using the
 * functions below.
 *
 * Since: 3.46
 **/
struct _EGDataSession {
	/*< private >*/
	ESoupSession parent;
	EGDataSessionPrivate *priv;
};

struct _EGDataSessionClass {
	ESoupSessionClass parent_class;

	/* Padding for future expansion */
	gpointer reserved[10];
};

GType		e_gdata_session_get_type		(void) G_GNUC_CONST;

EGDataSession *	e_gdata_session_new			(ESource *source);

const gchar *	e_gdata_tasklist_get_id			(JsonObject *tasklist);
void		e_gdata_tasklist_add_id			(JsonBuilder *builder,
							 const gchar *value);
const gchar *	e_gdata_tasklist_get_etag		(JsonObject *tasklist);
const gchar *	e_gdata_tasklist_get_title		(JsonObject *tasklist);
void		e_gdata_tasklist_add_title		(JsonBuilder *builder,
							 const gchar *value);
const gchar *	e_gdata_tasklist_get_self_link		(JsonObject *tasklist);
gint64		e_gdata_tasklist_get_updated		(JsonObject *tasklist);

gboolean	e_gdata_session_tasklists_delete_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasklists_get_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 JsonObject **out_tasklist,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasklists_insert_sync	(EGDataSession *self,
							 const gchar *title,
							 JsonObject **out_inserted_tasklist,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasklists_list_sync	(EGDataSession *self,
							 EGDataQuery *query,
							 EGDataObjectCallback cb,
							 gpointer user_data,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasklists_patch_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 JsonBuilder *tasklist_properties,
							 JsonObject **out_patched_tasklist,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasklists_update_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 JsonBuilder *tasklist,
							 JsonObject **out_updated_tasklist,
							 GCancellable *cancellable,
							 GError **error);

/**
 * EGDataTaskStatus:
 * @E_GDATA_TASK_STATUS_UNKNOWN: unknown status
 * @E_GDATA_TASK_STATUS_NEEDS_ACTION: the task needs action
 * @E_GDATA_TASK_STATUS_COMPLETED: the task is completed
 *
 * Holds status of a task.
 *
 * Since: 3.46
 **/
typedef enum {
	E_GDATA_TASK_STATUS_UNKNOWN,
	E_GDATA_TASK_STATUS_NEEDS_ACTION,
	E_GDATA_TASK_STATUS_COMPLETED
} EGDataTaskStatus;

const gchar *	e_gdata_task_get_id			(JsonObject *task);
void		e_gdata_task_add_id			(JsonBuilder *builder,
							 const gchar *value);
const gchar *	e_gdata_task_get_etag			(JsonObject *task);
const gchar *	e_gdata_task_get_title			(JsonObject *task);
void		e_gdata_task_add_title			(JsonBuilder *builder,
							 const gchar *value);
gint64		e_gdata_task_get_updated		(JsonObject *task);
const gchar *	e_gdata_task_get_self_link		(JsonObject *task);
const gchar *	e_gdata_task_get_parent			(JsonObject *task);
const gchar *	e_gdata_task_get_position		(JsonObject *task);
const gchar *	e_gdata_task_get_notes			(JsonObject *task);
void		e_gdata_task_add_notes			(JsonBuilder *builder,
							 const gchar *value);
EGDataTaskStatus
		e_gdata_task_get_status			(JsonObject *task);
void		e_gdata_task_add_status			(JsonBuilder *builder,
							 EGDataTaskStatus value);
gint64		e_gdata_task_get_due			(JsonObject *task);
void		e_gdata_task_add_due			(JsonBuilder *builder,
							 gint64 value);
gint64		e_gdata_task_get_completed		(JsonObject *task);
void		e_gdata_task_add_completed		(JsonBuilder *builder,
							 gint64 value);
gboolean	e_gdata_task_get_deleted		(JsonObject *task);
gboolean	e_gdata_task_get_hidden			(JsonObject *task);

gboolean	e_gdata_session_tasks_clear_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_delete_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 const gchar *task_id,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_get_sync		(EGDataSession *self,
							 const gchar *tasklist_id,
							 const gchar *task_id,
							 JsonObject **out_task,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_insert_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 JsonBuilder *task,
							 const gchar *parent_task_id,
							 const gchar *previous_task_id,
							 JsonObject **out_inserted_task,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_list_sync		(EGDataSession *self,
							 const gchar *tasklist_id,
							 EGDataQuery *query,
							 EGDataObjectCallback cb,
							 gpointer user_data,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_move_sync		(EGDataSession *self,
							 const gchar *tasklist_id,
							 const gchar *task_id,
							 const gchar *parent_task_id,
							 const gchar *previous_task_id,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_patch_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 const gchar *task_id,
							 JsonBuilder *task_properties,
							 JsonObject **out_patched_task,
							 GCancellable *cancellable,
							 GError **error);
gboolean	e_gdata_session_tasks_update_sync	(EGDataSession *self,
							 const gchar *tasklist_id,
							 const gchar *task_id,
							 JsonBuilder *task,
							 JsonObject **out_updated_task,
							 GCancellable *cancellable,
							 GError **error);

G_END_DECLS

#endif /* E_GDATA_SESSION_H */