summaryrefslogtreecommitdiff
path: root/mission-control-plugins/account-storage.h
blob: fd6daee1828c12fb179114ba37730274f53f93db (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
/* Mission Control plugin API - Account storage hook.
 *
 * Copyright © 2010 Nokia Corporation
 * Copyright © 2010 Collabora Ltd.
 *
 * This library 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.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef MCP_ACCOUNT_STORAGE_H
#define MCP_ACCOUNT_STORAGE_H

#ifndef _MCP_IN_MISSION_CONTROL_PLUGINS_H
#error Use <mission-control-plugins/mission-control-plugins.h> instead
#endif

G_BEGIN_DECLS

#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY -1
#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT   0
#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL    100

typedef enum /*< flags >*/
{
    MCP_PARAMETER_FLAG_NONE = 0
} McpParameterFlags;

typedef enum /*< flags >*/
{
    MCP_ATTRIBUTE_FLAG_NONE = 0
} McpAttributeFlags;

typedef enum {
    MCP_ACCOUNT_STORAGE_SET_RESULT_FAILED = 0,
    MCP_ACCOUNT_STORAGE_SET_RESULT_CHANGED,
    MCP_ACCOUNT_STORAGE_SET_RESULT_UNCHANGED
} McpAccountStorageSetResult;

/* API for plugins to implement */
typedef struct _McpAccountStorage McpAccountStorage;
typedef struct _McpAccountStorageIface McpAccountStorageIface;

#ifdef _i_used_gtk_doc_but_all_i_got_was_this_heap_of_workarounds
/* Without this, gtk-doc doesn't generate documentation for
 * #McpAccountStorage. There is actually no such struct: do not attempt
 * to use it. */
struct _McpAccountStorage { };
#endif

#define MCP_TYPE_ACCOUNT_STORAGE (mcp_account_storage_get_type ())

#define MCP_ACCOUNT_STORAGE(o) \
  (G_TYPE_CHECK_INSTANCE_CAST ((o), MCP_TYPE_ACCOUNT_STORAGE, \
      McpAccountStorage))

#define MCP_IS_ACCOUNT_STORAGE(o) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((o), MCP_TYPE_ACCOUNT_STORAGE))

#define MCP_ACCOUNT_STORAGE_GET_IFACE(o) \
  (G_TYPE_INSTANCE_GET_INTERFACE ((o), MCP_TYPE_ACCOUNT_STORAGE, \
                                  McpAccountStorageIface))

GType mcp_account_storage_get_type (void);

typedef gchar * (*McpAccountStorageCreate) (
    McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *manager,
    const gchar *protocol,
    const gchar *identification,
    GError **error);
typedef TpStorageRestrictionFlags (*McpAccountStorageGetRestrictionsFunc) (
    McpAccountStorage *storage,
    const gchar *account);

struct _McpAccountStorageIface
{
  GTypeInterface parent;

  gint priority;
  const gchar *name;
  const gchar *desc;
  const gchar *provider;

  void (*delete_async) (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      GCancellable *cancellable,
      GAsyncReadyCallback callback,
      gpointer user_data);
  gboolean (*delete_finish) (McpAccountStorage *storage,
      GAsyncResult *res,
      GError **error);

  gboolean (*commit) (McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *account);

  GList * (*list) (McpAccountStorage *storage,
    McpAccountManager *am);

  void (*ready) (McpAccountStorage *storage,
    McpAccountManager *am);

  void (*get_identifier) (McpAccountStorage *storage,
    const gchar *account,
    GValue *identifier);

  GHashTable * (*get_additional_info) (McpAccountStorage *storage,
    const gchar *account);

  TpStorageRestrictionFlags (*get_restrictions) (McpAccountStorage *storage,
    const gchar *account);

  gchar * (*create) (McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *manager,
    const gchar *protocol,
    const gchar *identification,
    GError **error);

  GVariant *(*get_attribute) (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      const gchar *attribute,
      const GVariantType *type,
      McpAttributeFlags *flags);
  GVariant *(*get_parameter) (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      const gchar *parameter,
      const GVariantType *type,
      McpParameterFlags *flags);

  McpAccountStorageSetResult (*set_attribute) (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      const gchar *attribute,
      GVariant *val,
      McpAttributeFlags flags);
  McpAccountStorageSetResult (*set_parameter) (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      const gchar *parameter,
      GVariant *val,
      McpParameterFlags flags);
};

/* virtual methods */
gint mcp_account_storage_priority (McpAccountStorage *storage);

gchar * mcp_account_storage_create (McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *manager,
    const gchar *protocol,
    const gchar *identification,
    GError **error);

void mcp_account_storage_delete_async (McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *account,
    GCancellable *cancellable,
    GAsyncReadyCallback callback,
    gpointer user_data);
gboolean mcp_account_storage_delete_finish (McpAccountStorage *storage,
    GAsyncResult *result,
    GError **error);

void mcp_account_storage_ready (McpAccountStorage *storage,
    McpAccountManager *am);

gboolean
mcp_account_storage_commit (McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *account);

GList *mcp_account_storage_list (McpAccountStorage *storage,
    McpAccountManager *am);

void mcp_account_storage_get_identifier (McpAccountStorage *storage,
    const gchar *account,
    GValue *identifier);

GHashTable *mcp_account_storage_get_additional_info (
    McpAccountStorage *storage,
    const gchar *account);

TpStorageRestrictionFlags mcp_account_storage_get_restrictions (
    McpAccountStorage *storage,
    const gchar *account);

const gchar *mcp_account_storage_name (McpAccountStorage *storage);

const gchar *mcp_account_storage_description (McpAccountStorage *storage);
const gchar *mcp_account_storage_provider (McpAccountStorage *storage);

GVariant *mcp_account_storage_get_attribute (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      const gchar *attribute,
      const GVariantType *type,
      McpAttributeFlags *flags);
GVariant *mcp_account_storage_get_parameter (McpAccountStorage *storage,
      McpAccountManager *am,
      const gchar *account,
      const gchar *parameter,
      const GVariantType *type,
      McpParameterFlags *flags);

McpAccountStorageSetResult mcp_account_storage_set_attribute (
    McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *account,
    const gchar *attribute,
    GVariant *value,
    McpAttributeFlags flags);
McpAccountStorageSetResult mcp_account_storage_set_parameter (
    McpAccountStorage *storage,
    McpAccountManager *am,
    const gchar *account,
    const gchar *parameter,
    GVariant *value,
    McpParameterFlags flags);

void mcp_account_storage_emit_created (McpAccountStorage *storage,
    const gchar *account);
void mcp_account_storage_emit_altered_one (McpAccountStorage *storage,
    const gchar *account,
    const gchar *key);
void mcp_account_storage_emit_deleted (McpAccountStorage *storage,
    const gchar *account);
void mcp_account_storage_emit_toggled (McpAccountStorage *storage,
    const gchar *account,
    gboolean enabled);
void mcp_account_storage_emit_reconnect (McpAccountStorage *storage,
    const gchar *account);

G_END_DECLS

#endif