~ubuntu-branches/ubuntu/precise/telepathy-mission-control-5/precise : revision 0.12.2

1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

2

<html>

3

<head>

4

5

<title>McpAccountStorage</title>

6

7

8

9

10

11

12

13

</head>

14

15

16

17

18

19

20

<th width="100%" align="center">Mission Control Plugins Reference Manual</th>

21

22

</tr>

23

24

25

|

26

<a href="#mission-control-plugins-McpAccountStorage.description" class="shortcut">Description</a>

27

</td></tr>

28

</table>

29

30

31

32

33

<h2><a name="mission-control-plugins-McpAccountStorage.top_of_page"></a>McpAccountStorage</h2>

34

McpAccountStorage — Account Storage object, implemented by plugins

35

</td>

36

37

</tr></table></div>

38

39

<a name="mission-control-plugins-McpAccountStorage.synopsis"></a><h2>Synopsis</h2>

40

41

#include <mission-control-plugins/mission-control-plugins.h>

42

43

#define <a class="link" href="mission-control-plugins-McpAccountStorage.html#MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-READONLY:CAPS" title="MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY">MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY</a>

44

#define <a class="link" href="mission-control-plugins-McpAccountStorage.html#MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-DEFAULT:CAPS" title="MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT">MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT</a>

45

#define <a class="link" href="mission-control-plugins-McpAccountStorage.html#MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-NORMAL:CAPS" title="MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL">MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL</a>

46

#define <a class="link" href="mission-control-plugins-McpAccountStorage.html#MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-KEYRING:CAPS" title="MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING">MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING</a>

47

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetFunc" title="McpAccountStorageGetFunc ()">*McpAccountStorageGetFunc</a>) (<code>const McpAccountStorage *storage</code>,

48

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

49

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

50

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);

51

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageSetFunc" title="McpAccountStorageSetFunc ()">*McpAccountStorageSetFunc</a>) (<code>const McpAccountStorage *storage</code>,

52

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

53

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

54

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

55

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *val</code>);

56

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageDeleteFunc" title="McpAccountStorageDeleteFunc ()">*McpAccountStorageDeleteFunc</a>) (<code>const McpAccountStorage *storage</code>,

57

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

58

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

59

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);

60

<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageListFunc" title="McpAccountStorageListFunc ()">*McpAccountStorageListFunc</a>) (<code>const McpAccountStorage *storage</code>,

61

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);

62

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageCommitFunc" title="McpAccountStorageCommitFunc ()">*McpAccountStorageCommitFunc</a>) (<code>const McpAccountStorage *storage</code>,

63

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);

64

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageCommitOneFunc" title="McpAccountStorageCommitOneFunc ()">*McpAccountStorageCommitOneFunc</a>) (<code>const McpAccountStorage *storage</code>,

65

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

66

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);

67

void (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageReadyFunc" title="McpAccountStorageReadyFunc ()">*McpAccountStorageReadyFunc</a>) (<code>const McpAccountStorage *storage</code>,

68

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);

69

void (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetIdentifierFunc" title="McpAccountStorageGetIdentifierFunc ()">*McpAccountStorageGetIdentifierFunc</a>)

70

(<code>const McpAccountStorage *storage</code>,

71

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

72

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *identifier</code>);

73

<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> * (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetAdditionalInfoFunc" title="McpAccountStorageGetAdditionalInfoFunc ()">*McpAccountStorageGetAdditionalInfoFunc</a>)

74

(<code>const McpAccountStorage *storage</code>,

75

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);

76

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> (<a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetRestrictionsFunc" title="McpAccountStorageGetRestrictionsFunc ()">*McpAccountStorageGetRestrictionsFunc</a>)

77

(<code>const McpAccountStorage *storage</code>,

78

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);

79

struct <a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a>;

80

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-priority" title="mcp_account_storage_iface_set_priority ()">mcp_account_storage_iface_set_priority</a>

81

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

82

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> prio</code>);

83

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-name" title="mcp_account_storage_iface_set_name ()">mcp_account_storage_iface_set_name</a> (<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

84

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *name</code>);

85

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-desc" title="mcp_account_storage_iface_set_desc ()">mcp_account_storage_iface_set_desc</a> (<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

86

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *desc</code>);

87

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-provider" title="mcp_account_storage_iface_set_provider ()">mcp_account_storage_iface_set_provider</a>

88

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

89

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *provider</code>);

90

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get" title="mcp_account_storage_iface_implement_get ()">mcp_account_storage_iface_implement_get</a>

91

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

92

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetFunc" title="McpAccountStorageGetFunc ()">McpAccountStorageGetFunc</a> method</code>);

93

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-set" title="mcp_account_storage_iface_implement_set ()">mcp_account_storage_iface_implement_set</a>

94

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

95

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageSetFunc" title="McpAccountStorageSetFunc ()">McpAccountStorageSetFunc</a> method</code>);

96

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-delete" title="mcp_account_storage_iface_implement_delete ()">mcp_account_storage_iface_implement_delete</a>

97

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

98

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageDeleteFunc" title="McpAccountStorageDeleteFunc ()">McpAccountStorageDeleteFunc</a> method</code>);

99

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-list" title="mcp_account_storage_iface_implement_list ()">mcp_account_storage_iface_implement_list</a>

100

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

101

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageListFunc" title="McpAccountStorageListFunc ()">McpAccountStorageListFunc</a> method</code>);

102

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-commit" title="mcp_account_storage_iface_implement_commit ()">mcp_account_storage_iface_implement_commit</a>

103

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

104

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageCommitFunc" title="McpAccountStorageCommitFunc ()">McpAccountStorageCommitFunc</a> method</code>);

105

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-commit-one" title="mcp_account_storage_iface_implement_commit_one ()">mcp_account_storage_iface_implement_commit_one</a>

106

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

107

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageCommitOneFunc" title="McpAccountStorageCommitOneFunc ()">McpAccountStorageCommitOneFunc</a> method</code>);

108

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-ready" title="mcp_account_storage_iface_implement_ready ()">mcp_account_storage_iface_implement_ready</a>

109

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

110

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageReadyFunc" title="McpAccountStorageReadyFunc ()">McpAccountStorageReadyFunc</a> method</code>);

111

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get-identifier" title="mcp_account_storage_iface_implement_get_identifier ()">mcp_account_storage_iface_implement_get_identifier</a>

112

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

113

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetIdentifierFunc" title="McpAccountStorageGetIdentifierFunc ()">McpAccountStorageGetIdentifierFunc</a> method</code>);

114

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get-additional-info" title="mcp_account_storage_iface_implement_get_additional_info ()">mcp_account_storage_iface_implement_get_additional_info</a>

115

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

116

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetAdditionalInfoFunc" title="McpAccountStorageGetAdditionalInfoFunc ()">McpAccountStorageGetAdditionalInfoFunc</a> method</code>);

117

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get-restrictions" title="mcp_account_storage_iface_implement_get_restrictions ()">mcp_account_storage_iface_implement_get_restrictions</a>

118

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

119

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetRestrictionsFunc" title="McpAccountStorageGetRestrictionsFunc ()">McpAccountStorageGetRestrictionsFunc</a> method</code>);

120

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-priority" title="mcp_account_storage_priority ()">mcp_account_storage_priority</a> (<code>const McpAccountStorage *storage</code>);

121

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-get" title="mcp_account_storage_get ()">mcp_account_storage_get</a> (<code>const McpAccountStorage *storage</code>,

122

<code><a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

123

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

124

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);

125

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-set" title="mcp_account_storage_set ()">mcp_account_storage_set</a> (<code>const McpAccountStorage *storage</code>,

126

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

127

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

128

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

129

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *val</code>);

130

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-delete" title="mcp_account_storage_delete ()">mcp_account_storage_delete</a> (<code>const McpAccountStorage *storage</code>,

131

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

132

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

133

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);

134

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-ready" title="mcp_account_storage_ready ()">mcp_account_storage_ready</a> (<code>const McpAccountStorage *storage</code>,

135

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);

136

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-commit" title="mcp_account_storage_commit ()">mcp_account_storage_commit</a> (<code>const McpAccountStorage *storage</code>,

137

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);

138

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-commit-one" title="mcp_account_storage_commit_one ()">mcp_account_storage_commit_one</a> (<code>const McpAccountStorage *storage</code>,

139

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

140

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);

141

<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-list" title="mcp_account_storage_list ()">mcp_account_storage_list</a> (<code>const McpAccountStorage *storage</code>,

142

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);

143

void <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-get-identifier" title="mcp_account_storage_get_identifier ()">mcp_account_storage_get_identifier</a> (<code>const McpAccountStorage *storage</code>,

144

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

145

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *identifier</code>);

146

<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> * <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-get-additional-info" title="mcp_account_storage_get_additional_info ()">mcp_account_storage_get_additional_info</a>

147

(<code>const McpAccountStorage *storage</code>,

148

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);

149

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-get-restrictions" title="mcp_account_storage_get_restrictions ()">mcp_account_storage_get_restrictions</a>

150

(<code>const McpAccountStorage *storage</code>,

151

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);

152

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-name" title="mcp_account_storage_name ()">mcp_account_storage_name</a> (<code>const McpAccountStorage *storage</code>);

153

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-description" title="mcp_account_storage_description ()">mcp_account_storage_description</a> (<code>const McpAccountStorage *storage</code>);

154

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-provider" title="mcp_account_storage_provider ()">mcp_account_storage_provider</a> (<code>const McpAccountStorage *storage</code>);

155

</pre>

156

</div>

157

158

<a name="mission-control-plugins-McpAccountStorage.description"></a><h2>Description</h2>

159

160

Plugins may implement McpAccountStorage in order to provide account

161

parameter storage backends to the AccountManager object.

162

163

164

To do so, the plugin must implement a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> subclass that implements

165

McpAccountStorage, then return an instance of that subclass from

166

<a class="link" href="mission-control-plugins-Plugin-loader-and-global-functions.html#mcp-plugin-ref-nth-object" title="mcp_plugin_ref_nth_object ()"><code class="function">mcp_plugin_ref_nth_object()</code></a>.

167

168

169

The contents of the McpAccountStorage struct are not public,

170

so to provide an implementation of the virtual methods,

171

plugins should call mcp_account_operation_iface_implement_*()

172

from the interface initialization function, like this:

173

174

175

176

177

<a name="idp7519760"></a>Example 1.

178

179

180

<tbody>

181

<tr>

182

<td class="listing_lines" align="right"><pre>1

183

2

184

3

185

4

186

5

187

6

188

7

189

8

190

9

191

10

192

11

193

12

194

13

195

14

196

15

197

16

198

17

199

18

200

19

201

20

202

21

203

22

204

23

205

24

206

25

207

26

208

27

209

28

210

29

211

30</pre></td>

212

<td class="listing_code"><pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-DEFINE-TYPE-WITH-CODE:CAPS">G_DEFINE_TYPE_WITH_CODE</a> (APlugin, a_plugin,

213

G_TYPE_OBJECT,

214

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-IMPLEMENT-INTERFACE:CAPS">G_IMPLEMENT_INTERFACE</a> (...);

215

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-IMPLEMENT-INTERFACE:CAPS">G_IMPLEMENT_INTERFACE</a> (MCP_TYPE_ACCOUNT_STORAGE,

216

account_storage_iface_init));

217

/* ... */

218

static void

219

account_storage_iface_init (McpAccountStorageIface *iface,

220

gpointer unused G_GNUC_UNUSED)

221

{

222

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-priority">mcp_account_storage_iface_set_priority</a> (iface, 0);

223

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-name">mcp_account_storage_iface_set_name</a> (iface, "foo")

224

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-desc">mcp_account_storage_iface_set_desc</a> (iface, "The FOO storage backend");

225

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-set-provider">mcp_account_storage_iface_set_provider</a> (iface,

226

"org.freedesktop.Telepathy.MissionControl5.FooStorage");

227

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get">mcp_account_storage_iface_implement_get</a> (iface, _plugin_getval);

228

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-set">mcp_account_storage_iface_implement_set</a> (iface, _plugin_setval);

229

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-delete">mcp_account_storage_iface_implement_delete</a> (iface, _plugin_delete);

230

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-commit">mcp_account_storage_iface_implement_commit</a> (iface, _plugin_commit);

231

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-commit-one">mcp_account_storage_iface_implement_commit_one</a> (iface, _plugin_commit_one);

232

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-list">mcp_account_storage_iface_implement_list</a> (iface, _plugin_list);

233

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-ready">mcp_account_storage_iface_implement_ready</a> (iface, _plugin_ready);

234

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get-identifier">mcp_account_storage_iface_implement_get_identifier</a> (iface,

235

_plugin_get_identifier);

236

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get-additional-info">mcp_account_storage_iface_implement_get_additional_info</a> (iface,

237

_plugin_get_additional_info);

238

<a href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-iface-implement-get-restrictions">mcp_account_storage_iface_implement_get_restrictions</a> (iface,

239

_plugin_get_restrictions);

240

/* ... */

241

}</pre></td>

242

</tr>

243

</tbody>

244

</table>

245

</div>

246

247

</div>

248

249

250

251

A single object can implement more than one interface; It is currently

252

unlikely that you would find it useful to implement anything other than

253

an account storage plugin in an account storage object, though.

254

255

</div>

256

257

<a name="mission-control-plugins-McpAccountStorage.details"></a><h2>Details</h2>

258

259

<a name="MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-READONLY:CAPS"></a><h3>MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY</h3>

260

<pre class="programlisting">#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_READONLY -1

261

</pre>

262

263

264

</div>

265

<hr>

266

267

<a name="MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-DEFAULT:CAPS"></a><h3>MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT</h3>

268

<pre class="programlisting">#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT 0

269

</pre>

270

271

272

</div>

273

<hr>

274

275

<a name="MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-NORMAL:CAPS"></a><h3>MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL</h3>

276

<pre class="programlisting">#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_NORMAL 100

277

</pre>

278

279

280

</div>

281

<hr>

282

283

<a name="MCP-ACCOUNT-STORAGE-PLUGIN-PRIO-KEYRING:CAPS"></a><h3>MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING</h3>

284

<pre class="programlisting">#define MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING 10000

285

</pre>

286

287

288

</div>

289

<hr>

290

291

<a name="McpAccountStorageGetFunc"></a><h3>McpAccountStorageGetFunc ()</h3>

292

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (*McpAccountStorageGetFunc) (<code>const McpAccountStorage *storage</code>,

293

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

294

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

295

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

296

297

298

</div>

299

<hr>

300

301

<a name="McpAccountStorageSetFunc"></a><h3>McpAccountStorageSetFunc ()</h3>

302

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (*McpAccountStorageSetFunc) (<code>const McpAccountStorage *storage</code>,

303

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

304

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

305

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

306

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *val</code>);</pre>

307

308

309

</div>

310

<hr>

311

312

<a name="McpAccountStorageDeleteFunc"></a><h3>McpAccountStorageDeleteFunc ()</h3>

313

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (*McpAccountStorageDeleteFunc) (<code>const McpAccountStorage *storage</code>,

314

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

315

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

316

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

317

318

319

</div>

320

<hr>

321

322

<a name="McpAccountStorageListFunc"></a><h3>McpAccountStorageListFunc ()</h3>

323

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * (*McpAccountStorageListFunc) (<code>const McpAccountStorage *storage</code>,

324

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);</pre>

325

326

327

</div>

328

<hr>

329

330

<a name="McpAccountStorageCommitFunc"></a><h3>McpAccountStorageCommitFunc ()</h3>

331

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (*McpAccountStorageCommitFunc) (<code>const McpAccountStorage *storage</code>,

332

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);</pre>

333

334

335

</div>

336

<hr>

337

338

<a name="McpAccountStorageCommitOneFunc"></a><h3>McpAccountStorageCommitOneFunc ()</h3>

339

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (*McpAccountStorageCommitOneFunc) (<code>const McpAccountStorage *storage</code>,

340

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

341

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);</pre>

342

343

344

</div>

345

<hr>

346

347

<a name="McpAccountStorageReadyFunc"></a><h3>McpAccountStorageReadyFunc ()</h3>

348

<pre class="programlisting">void (*McpAccountStorageReadyFunc) (<code>const McpAccountStorage *storage</code>,

349

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);</pre>

350

351

352

</div>

353

<hr>

354

355

<a name="McpAccountStorageGetIdentifierFunc"></a><h3>McpAccountStorageGetIdentifierFunc ()</h3>

356

<pre class="programlisting">void (*McpAccountStorageGetIdentifierFunc)

357

(<code>const McpAccountStorage *storage</code>,

358

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

359

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *identifier</code>);</pre>

360

361

362

</div>

363

<hr>

364

365

<a name="McpAccountStorageGetAdditionalInfoFunc"></a><h3>McpAccountStorageGetAdditionalInfoFunc ()</h3>

366

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> * (*McpAccountStorageGetAdditionalInfoFunc)

367

(<code>const McpAccountStorage *storage</code>,

368

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);</pre>

369

370

371

</div>

372

<hr>

373

374

<a name="McpAccountStorageGetRestrictionsFunc"></a><h3>McpAccountStorageGetRestrictionsFunc ()</h3>

375

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> (*McpAccountStorageGetRestrictionsFunc)

376

(<code>const McpAccountStorage *storage</code>,

377

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);</pre>

378

379

380

</div>

381

<hr>

382

383

<a name="McpAccountStorageIface"></a><h3>struct McpAccountStorageIface</h3>

384

<pre class="programlisting">struct McpAccountStorageIface {

385

GTypeInterface parent;

386

387

gint priority;

388

const gchar *name;

389

const gchar *desc;

390

const gchar *provider;

391

392

McpAccountStorageSetFunc set;

393

McpAccountStorageGetFunc get;

394

McpAccountStorageDeleteFunc delete;

395

McpAccountStorageCommitFunc commit;

396

McpAccountStorageListFunc list;

397

McpAccountStorageReadyFunc ready;

398

McpAccountStorageCommitOneFunc commit_one;

399

McpAccountStorageGetIdentifierFunc get_identifier;

400

McpAccountStorageGetAdditionalInfoFunc get_additional_info;

401

McpAccountStorageGetRestrictionsFunc get_restrictions;

402

};

403

</pre>

404

405

406

</div>

407

<hr>

408

409

<a name="mcp-account-storage-iface-set-priority"></a><h3>mcp_account_storage_iface_set_priority ()</h3>

410

<pre class="programlisting">void mcp_account_storage_iface_set_priority

411

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

412

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> prio</code>);</pre>

413

414

415

</div>

416

<hr>

417

418

<a name="mcp-account-storage-iface-set-name"></a><h3>mcp_account_storage_iface_set_name ()</h3>

419

<pre class="programlisting">void mcp_account_storage_iface_set_name (<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

420

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *name</code>);</pre>

421

422

423

</div>

424

<hr>

425

426

<a name="mcp-account-storage-iface-set-desc"></a><h3>mcp_account_storage_iface_set_desc ()</h3>

427

<pre class="programlisting">void mcp_account_storage_iface_set_desc (<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

428

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *desc</code>);</pre>

429

430

431

</div>

432

<hr>

433

434

<a name="mcp-account-storage-iface-set-provider"></a><h3>mcp_account_storage_iface_set_provider ()</h3>

435

<pre class="programlisting">void mcp_account_storage_iface_set_provider

436

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

437

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *provider</code>);</pre>

438

439

440

</div>

441

<hr>

442

443

<a name="mcp-account-storage-iface-implement-get"></a><h3>mcp_account_storage_iface_implement_get ()</h3>

444

<pre class="programlisting">void mcp_account_storage_iface_implement_get

445

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

446

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetFunc" title="McpAccountStorageGetFunc ()">McpAccountStorageGetFunc</a> method</code>);</pre>

447

448

449

</div>

450

<hr>

451

452

<a name="mcp-account-storage-iface-implement-set"></a><h3>mcp_account_storage_iface_implement_set ()</h3>

453

<pre class="programlisting">void mcp_account_storage_iface_implement_set

454

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

455

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageSetFunc" title="McpAccountStorageSetFunc ()">McpAccountStorageSetFunc</a> method</code>);</pre>

456

457

458

</div>

459

<hr>

460

461

<a name="mcp-account-storage-iface-implement-delete"></a><h3>mcp_account_storage_iface_implement_delete ()</h3>

462

<pre class="programlisting">void mcp_account_storage_iface_implement_delete

463

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

464

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageDeleteFunc" title="McpAccountStorageDeleteFunc ()">McpAccountStorageDeleteFunc</a> method</code>);</pre>

465

466

467

</div>

468

<hr>

469

470

<a name="mcp-account-storage-iface-implement-list"></a><h3>mcp_account_storage_iface_implement_list ()</h3>

471

<pre class="programlisting">void mcp_account_storage_iface_implement_list

472

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

473

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageListFunc" title="McpAccountStorageListFunc ()">McpAccountStorageListFunc</a> method</code>);</pre>

474

475

476

</div>

477

<hr>

478

479

<a name="mcp-account-storage-iface-implement-commit"></a><h3>mcp_account_storage_iface_implement_commit ()</h3>

480

<pre class="programlisting">void mcp_account_storage_iface_implement_commit

481

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

482

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageCommitFunc" title="McpAccountStorageCommitFunc ()">McpAccountStorageCommitFunc</a> method</code>);</pre>

483

484

485

</div>

486

<hr>

487

488

<a name="mcp-account-storage-iface-implement-commit-one"></a><h3>mcp_account_storage_iface_implement_commit_one ()</h3>

489

<pre class="programlisting">void mcp_account_storage_iface_implement_commit_one

490

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

491

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageCommitOneFunc" title="McpAccountStorageCommitOneFunc ()">McpAccountStorageCommitOneFunc</a> method</code>);</pre>

492

493

494

</div>

495

<hr>

496

497

<a name="mcp-account-storage-iface-implement-ready"></a><h3>mcp_account_storage_iface_implement_ready ()</h3>

498

<pre class="programlisting">void mcp_account_storage_iface_implement_ready

499

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

500

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageReadyFunc" title="McpAccountStorageReadyFunc ()">McpAccountStorageReadyFunc</a> method</code>);</pre>

501

502

503

</div>

504

<hr>

505

506

<a name="mcp-account-storage-iface-implement-get-identifier"></a><h3>mcp_account_storage_iface_implement_get_identifier ()</h3>

507

<pre class="programlisting">void mcp_account_storage_iface_implement_get_identifier

508

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

509

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetIdentifierFunc" title="McpAccountStorageGetIdentifierFunc ()">McpAccountStorageGetIdentifierFunc</a> method</code>);</pre>

510

511

512

</div>

513

<hr>

514

515

<a name="mcp-account-storage-iface-implement-get-additional-info"></a><h3>mcp_account_storage_iface_implement_get_additional_info ()</h3>

516

<pre class="programlisting">void mcp_account_storage_iface_implement_get_additional_info

517

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

518

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetAdditionalInfoFunc" title="McpAccountStorageGetAdditionalInfoFunc ()">McpAccountStorageGetAdditionalInfoFunc</a> method</code>);</pre>

519

520

521

</div>

522

<hr>

523

524

<a name="mcp-account-storage-iface-implement-get-restrictions"></a><h3>mcp_account_storage_iface_implement_get_restrictions ()</h3>

525

<pre class="programlisting">void mcp_account_storage_iface_implement_get_restrictions

526

(<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageIface" title="struct McpAccountStorageIface">McpAccountStorageIface</a> *iface</code>,

527

<code><a class="link" href="mission-control-plugins-McpAccountStorage.html#McpAccountStorageGetRestrictionsFunc" title="McpAccountStorageGetRestrictionsFunc ()">McpAccountStorageGetRestrictionsFunc</a> method</code>);</pre>

528

529

530

</div>

531

<hr>

532

533

<a name="mcp-account-storage-priority"></a><h3>mcp_account_storage_priority ()</h3>

534

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> mcp_account_storage_priority (<code>const McpAccountStorage *storage</code>);</pre>

535

536

537

<tbody>

538

<tr>

539

<td><code>storage</code> :</td>

540

<td>an McpAccountStorage instance</td>

541

</tr>

542

<tr>

543

<td>Returns :</td>

544

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> indicating the priority of the plugin.

545

Priorities currently run from MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_DEFAULT

546

(the default storage plugin priority) upwards.

547

Plugins at a higher priority then MCP_ACCOUNT_STORAGE_PLUGIN_PRIO_KEYRING

548

will have the opportunity to "steal" passwords from the gnome keyring:

549

Plugins at a lower priority than this will not receive secret parameters

550

from MC as the keyring plugin will already have claimed them.

551

Plugins at a lower priority than the default plugin will never be asked to

552

store any details, although they may still be asked to list them at startup

553

time, and may asynchronously notify MC of accounts via the signals above.

554

When loading accounts at startup, plugins are consulted in order from

555

lowest to highest, so that higher priority plugins may overrule settings

556

from lower priority plugins.

557

Loading all the accounts is only done at startup, before the dbus name

558

is claimed, and is therefore the only time plugins are allowed to indulge

559

in blocking calls (indeed, they are expected to carry out this operation,

560

and ONLY this operation, synchronously).

561

When values are being set, the plugins are invoked from highest priority

562

to lowest, with the first plugin that claims a setting being assigned

563

ownership, and all lower priority plugins being asked to delete the

564

setting in question.</td>

565

</tr>

566

</tbody>

567

</table></div>

568

</div>

569

<hr>

570

571

<a name="mcp-account-storage-get"></a><h3>mcp_account_storage_get ()</h3>

572

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> mcp_account_storage_get (<code>const McpAccountStorage *storage</code>,

573

<code><a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

574

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

575

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

576

577

The plugin is expected to quickly and synchronously update

578

the value associated with <code>key</code> using calls to <code>am</code>.

579

580

581

The plugin is not required to consult whatever long term storage

582

it uses, and may fetch said value from its internal cache, if any.

583

584

585

If <code>key</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> the plugin should write all its settings for <code>account</code>

586

into the account manager via <code>am</code>. The return value in this case should

587

be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if any settings were found.

588

589

590

591

<tbody>

592

<tr>

593

<td><code>storage</code> :</td>

594

<td>an McpAccountStorage instance</td>

595

</tr>

596

<tr>

597

598

<td>an <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> instance</td>

599

</tr>

600

<tr>

601

<td><code>account</code> :</td>

602

<td>the unique name of the account</td>

603

</tr>

604

<tr>

605

606

<td>the setting whose value we wish to fetch</td>

607

</tr>

608

<tr>

609

<td>Returns :</td>

610

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> - <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a value was found and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>

611

</tr>

612

</tbody>

613

</table></div>

614

</div>

615

<hr>

616

617

<a name="mcp-account-storage-set"></a><h3>mcp_account_storage_set ()</h3>

618

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> mcp_account_storage_set (<code>const McpAccountStorage *storage</code>,

619

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

620

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

621

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

622

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *val</code>);</pre>

623

624

The plugin is expected to either quickly and synchronously

625

update its internal cache of values with <code>value</code>, or to

626

decline to store the setting.

627

628

629

The plugin is not expected to write to its long term storage

630

at this point.

631

632

633

634

<tbody>

635

<tr>

636

<td><code>storage</code> :</td>

637

<td>an McpAccountStorage instance</td>

638

</tr>

639

<tr>

640

641

<td>an <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> instance</td>

642

</tr>

643

<tr>

644

<td><code>account</code> :</td>

645

<td>the unique name of the account</td>

646

</tr>

647

<tr>

648

649

<td>the setting whose value we wish to fetch</td>

650

</tr>

651

<tr>

652

<td>Returns :</td>

653

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> - <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the setting was claimed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>

654

</tr>

655

</tbody>

656

</table></div>

657

</div>

658

<hr>

659

660

<a name="mcp-account-storage-delete"></a><h3>mcp_account_storage_delete ()</h3>

661

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> mcp_account_storage_delete (<code>const McpAccountStorage *storage</code>,

662

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

663

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

664

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

665

666

The plugin is expected to remove the setting for <code>key</code> from its

667

internal cache and to remember that its state has changed, so

668

that it can delete said setting from its long term storage if

669

its long term storage method makes this necessary.

670

671

672

If <code>key</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the plugin should forget all its settings for

673

<code>account</code> (and remember to delete <code>account</code> from its storage later)

674

675

676

The plugin is not expected to update its long term storage at

677

this point.

678

679

680

681

<tbody>

682

<tr>

683

<td><code>storage</code> :</td>

684

<td>an McpAccountStorage instance</td>

685

</tr>

686

<tr>

687

688

<td>an <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> instance</td>

689

</tr>

690

<tr>

691

<td><code>account</code> :</td>

692

<td>the unique name of the account</td>

693

</tr>

694

<tr>

695

696

<td>the setting whose value we wish to fetch</td>

697

</tr>

698

<tr>

699

<td>Returns :</td>

700

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> - <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the setting or settings are not

701

the plugin's cache after this operation, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

702

This is very unlikely to ever be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, as a plugin is always

703

expected to be able to manipulate its own cache.</td>

704

</tr>

705

</tbody>

706

</table></div>

707

</div>

708

<hr>

709

710

<a name="mcp-account-storage-ready"></a><h3>mcp_account_storage_ready ()</h3>

711

<pre class="programlisting">void mcp_account_storage_ready (<code>const McpAccountStorage *storage</code>,

712

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);</pre>

713

714

Informs the plugin that it is now permitted to create new accounts,

715

ie it can now fire its "created", "altered", "toggled" and "deleted"

716

signals.

717

718

719

720

721

<td><code>storage</code> :</td>

722

<td>an McpAccountStorage instance</td>

723

</tr></tbody>

724

</table></div>

725

</div>

726

<hr>

727

728

<a name="mcp-account-storage-commit"></a><h3>mcp_account_storage_commit ()</h3>

729

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> mcp_account_storage_commit (<code>const McpAccountStorage *storage</code>,

730

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);</pre>

731

732

The plugin is expected to write its cache to long term storage,

733

deleting, adding or updating entries in said storage as needed.

734

735

736

This call is expected to return promptly, but the plugin is

737

not required to have finished its commit operation when it returns,

738

merely to have started the operation.

739

740

741

If the <code>commit_one</code> method is implemented, it will be called preferentially

742

if only one account is to be committed. If the <code>commit_one</code> method is

743

implemented but <code>commit</code> is not, <code>commit_one</code> will be called with

744

<code>account_name</code> = <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to commit all accounts.

745

746

747

748

<tbody>

749

<tr>

750

<td><code>storage</code> :</td>

751

<td>an McpAccountStorage instance</td>

752

</tr>

753

<tr>

754

755

<td>an <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> instance</td>

756

</tr>

757

<tr>

758

<td>Returns :</td>

759

<td>a gboolean - normally <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was a problem

760

that was immediately obvious.</td>

761

</tr>

762

</tbody>

763

</table></div>

764

</div>

765

<hr>

766

767

<a name="mcp-account-storage-commit-one"></a><h3>mcp_account_storage_commit_one ()</h3>

768

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> mcp_account_storage_commit_one (<code>const McpAccountStorage *storage</code>,

769

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>,

770

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);</pre>

771

772

The same as <a class="link" href="mission-control-plugins-McpAccountStorage.html#mcp-account-storage-commit" title="mcp_account_storage_commit ()"><code class="function">mcp_account_storage_commit()</code></a>, but only commit the given

773

account. This is optional to implement; the default implementation

774

is to call <code>commit</code>.

775

776

777

778

<tbody>

779

<tr>

780

<td><code>storage</code> :</td>

781

<td>an McpAccountStorage instance</td>

782

</tr>

783

<tr>

784

785

<td>an <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> instance</td>

786

</tr>

787

<tr>

788

<td><code>account</code> :</td>

789

<td>the unique suffix of an account's object path, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if

790

all accounts are to be committed</td>

791

</tr>

792

<tr>

793

<td>Returns :</td>

794

<td>a gboolean - normally <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was a problem

795

that was immediately obvious.</td>

796

</tr>

797

</tbody>

798

</table></div>

799

</div>

800

<hr>

801

802

<a name="mcp-account-storage-list"></a><h3>mcp_account_storage_list ()</h3>

803

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * mcp_account_storage_list (<code>const McpAccountStorage *storage</code>,

804

<code>const <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> *am</code>);</pre>

805

806

This method is called only at initialisation time, before the dbus name

807

has been claimed, and is the only one permitted to block.

808

809

810

811

<tbody>

812

<tr>

813

<td><code>storage</code> :</td>

814

<td>an McpAccountStorage instance</td>

815

</tr>

816

<tr>

817

818

<td>an <a class="link" href="McpAccountManager.html" title="McpAccountManager">McpAccountManager</a> instance</td>

819

</tr>

820

<tr>

821

<td>Returns :</td>

822

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> of <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a>* (the unique account names) that the plugin

823

has settings for. The <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> (and its contents) should be freed when the

824

caller is done with them.</td>

825

</tr>

826

</tbody>

827

</table></div>

828

</div>

829

<hr>

830

831

<a name="mcp-account-storage-get-identifier"></a><h3>mcp_account_storage_get_identifier ()</h3>

832

<pre class="programlisting">void mcp_account_storage_get_identifier (<code>const McpAccountStorage *storage</code>,

833

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>,

834

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *identifier</code>);</pre>

835

836

Get the storage-specific identifier for this account. The type is variant,

837

hence the GValue.

838

839

840

841

<tbody>

842

<tr>

843

<td><code>storage</code> :</td>

844

<td>an McpAccountStorage instance</td>

845

</tr>

846

<tr>

847

<td><code>account</code> :</td>

848

<td>the unique name of the account</td>

849

</tr>

850

<tr>

851

<td><code>identifier</code> :</td>

852

<td>a zero-filled <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> whose type can be sent over D-Bus by

853

dbus-glib to hold the identifier.</td>

854

</tr>

855

</tbody>

856

</table></div>

857

</div>

858

<hr>

859

860

<a name="mcp-account-storage-get-additional-info"></a><h3>mcp_account_storage_get_additional_info ()</h3>

861

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> * mcp_account_storage_get_additional_info

862

(<code>const McpAccountStorage *storage</code>,

863

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);</pre>

864

865

Return additional storage-specific information about this account, which is

866

made available on D-Bus but not otherwise interpreted by Mission Control.

867

868

869

870

<tbody>

871

<tr>

872

<td><code>storage</code> :</td>

873

<td>an McpAccountStorage instance</td>

874

</tr>

875

<tr>

876

<td><code>account</code> :</td>

877

<td>the unique name of the account</td>

878

</tr>

879

<tr>

880

<td>Returns :</td>

881

<td>a caller owned <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> mapping with string keys and <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a>

882

values.</td>

883

</tr>

884

</tbody>

885

</table></div>

886

</div>

887

<hr>

888

889

<a name="mcp-account-storage-get-restrictions"></a><h3>mcp_account_storage_get_restrictions ()</h3>

890

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> mcp_account_storage_get_restrictions

891

(<code>const McpAccountStorage *storage</code>,

892

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *account</code>);</pre>

893

894

895

<tbody>

896

<tr>

897

<td><code>storage</code> :</td>

898

<td>an McpAccountStorage instance</td>

899

</tr>

900

<tr>

901

<td><code>account</code> :</td>

902

<td>the unique name of the account</td>

903

</tr>

904

<tr>

905

<td>Returns :</td>

906

<td>a bitmask of <a href="http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-enums.html#TpStorageRestrictionFlags"><code class="literal">TpStorageRestrictionFlags</code></a> with the restrictions to

907

account storage.</td>

908

</tr>

909

</tbody>

910

</table></div>

911

</div>

912

<hr>

913

914

<a name="mcp-account-storage-name"></a><h3>mcp_account_storage_name ()</h3>

915

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * mcp_account_storage_name (<code>const McpAccountStorage *storage</code>);</pre>

916

917

918

<tbody>

919

<tr>

920

<td><code>storage</code> :</td>

921

<td>an McpAccountStorage instance</td>

922

</tr>

923

<tr>

924

<td>Returns :</td>

925

<td>a const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a>* : the plugin's name (for logging etc)</td>

926

</tr>

927

</tbody>

928

</table></div>

929

</div>

930

<hr>

931

932

<a name="mcp-account-storage-description"></a><h3>mcp_account_storage_description ()</h3>

933

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * mcp_account_storage_description (<code>const McpAccountStorage *storage</code>);</pre>

934

935

936

<tbody>

937

<tr>

938

<td><code>storage</code> :</td>

939

<td>an McpAccountStorage instance</td>

940

</tr>

941

<tr>

942

<td>Returns :</td>

943

<td>a const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a>* : the plugin's description (for logging etc)</td>

944

</tr>

945

</tbody>

946

</table></div>

947

</div>

948

<hr>

949

950

<a name="mcp-account-storage-provider"></a><h3>mcp_account_storage_provider ()</h3>

951

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * mcp_account_storage_provider (<code>const McpAccountStorage *storage</code>);</pre>

952

953

954

<tbody>

955

<tr>

956

<td><code>storage</code> :</td>

957

<td>an McpAccountStorage instance</td>

958

</tr>

959

<tr>

960

<td>Returns :</td>

961

<td>a const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a>* : the plugin's provider, a DBus namespaced name for

962

this plugin.</td>

963

</tr>

964

</tbody>

965

</table></div>

966

</div>

967

</div>

968

</div>

969

970

<hr>

971

Generated by GTK-Doc V1.17</div>

972

</body>

973

</html>

b'\\ No newline at end of file'