← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserverui/xml/e-passwords.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserverui/xml/e-passwords.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libedataserverui-e-passwords">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libedataserverui-e-passwords.top_of_page">e-passwords</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATASERVERUI Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>e-passwords</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libedataserverui-e-passwords.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis><link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-init">e_passwords_init</link>                    (<parameter><type>void</type></parameter>);
21
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-shutdown">e_passwords_shutdown</link>                (<parameter><type>void</type></parameter>);
22
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-cancel">e_passwords_cancel</link>                  (<parameter><type>void</type></parameter>);
23
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-set-online">e_passwords_set_online</link>              (<parameter><link linkend="gint"><type>gint</type></link> state</parameter>);
24
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-remember-password">e_passwords_remember_password</link>       (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>,
25
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
26
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-add-password">e_passwords_add_password</link>            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
27
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>);
28
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-passwords-get-password">e_passwords_get_password</link>            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>,
29
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
30
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-forget-password">e_passwords_forget_password</link>         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>,
31
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
32
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-forget-passwords">e_passwords_forget_passwords</link>        (<parameter><type>void</type></parameter>);
33
 
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-passwords-clear-passwords">e_passwords_clear_passwords</link>         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>);
34
 
enum                <link linkend="EPasswordsRememberType">EPasswordsRememberType</link>;
35
 
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-passwords-ask-password">e_passwords_ask_password</link>            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *title</parameter>,
36
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *component_name</parameter>,
37
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
38
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *prompt</parameter>,
39
 
                                                         <parameter><link linkend="EPasswordsRememberType"><type>EPasswordsRememberType</type></link> remember_type</parameter>,
40
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *remember</parameter>,
41
 
                                                         <parameter><link linkend="GtkWindow"><type>GtkWindow</type></link> *parent</parameter>);
42
 
</synopsis>
43
 
</refsynopsisdiv>
44
 
 
45
 
<refsect1 id="libedataserverui-e-passwords.description" role="desc">
46
 
<title role="desc.title">Description</title>
47
 
<para>
48
 
</para>
49
 
</refsect1>
50
 
<refsect1 id="libedataserverui-e-passwords.details" role="details">
51
 
<title role="details.title">Details</title>
52
 
<refsect2 id="e-passwords-init" role="function">
53
 
<title>e_passwords_init ()</title>
54
 
<indexterm zone="e-passwords-init"><primary>e_passwords_init</primary></indexterm>
55
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_init                    (<parameter><type>void</type></parameter>);</programlisting>
56
 
<para>
57
 
Initializes the e_passwords routines. Must be called before any other
58
 
e_passwords_* function.</para>
59
 
</refsect2>
60
 
<refsect2 id="e-passwords-shutdown" role="function">
61
 
<title>e_passwords_shutdown ()</title>
62
 
<indexterm zone="e-passwords-shutdown"><primary>e_passwords_shutdown</primary></indexterm>
63
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_shutdown                (<parameter><type>void</type></parameter>);</programlisting>
64
 
<para>
65
 
Cleanup routine to call before exiting.</para>
66
 
</refsect2>
67
 
<refsect2 id="e-passwords-cancel" role="function">
68
 
<title>e_passwords_cancel ()</title>
69
 
<indexterm zone="e-passwords-cancel"><primary>e_passwords_cancel</primary></indexterm>
70
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_cancel                  (<parameter><type>void</type></parameter>);</programlisting>
71
 
<para>
72
 
Cancel any outstanding password operations and close any dialogues
73
 
currently being shown.</para>
74
 
</refsect2>
75
 
<refsect2 id="e-passwords-set-online" role="function">
76
 
<title>e_passwords_set_online ()</title>
77
 
<indexterm zone="e-passwords-set-online"><primary>e_passwords_set_online</primary></indexterm>
78
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_set_online              (<parameter><link linkend="gint"><type>gint</type></link> state</parameter>);</programlisting>
79
 
<para>
80
 
Set the offline-state of the application.  This is a work-around
81
 
for having the backends fully offline aware, and returns a
82
 
cancellation response instead of prompting for passwords.
83
 
</para>
84
 
<para>
85
 
FIXME: This is not a permanent api, review post 2.0.</para>
86
 
</refsect2>
87
 
<refsect2 id="e-passwords-remember-password" role="function">
88
 
<title>e_passwords_remember_password ()</title>
89
 
<indexterm zone="e-passwords-remember-password"><primary>e_passwords_remember_password</primary></indexterm>
90
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_remember_password       (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>,
91
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
92
 
<para>
93
 
Saves the password associated with <parameter>key</parameter> to disk.</para>
94
 
<variablelist role="params">
95
 
<varlistentry><term><parameter>component</parameter>&#160;:</term>
96
 
<listitem><simpara>
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
99
 
<listitem><simpara>the key
100
 
</simpara></listitem></varlistentry>
101
 
</variablelist></refsect2>
102
 
<refsect2 id="e-passwords-add-password" role="function">
103
 
<title>e_passwords_add_password ()</title>
104
 
<indexterm zone="e-passwords-add-password"><primary>e_passwords_add_password</primary></indexterm>
105
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_add_password            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
106
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>);</programlisting>
107
 
<para>
108
 
This stores the <parameter>key</parameter>/<parameter>passwd</parameter> pair in the current session's password
109
 
hash.</para>
110
 
<variablelist role="params">
111
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
112
 
<listitem><simpara>a key
113
 
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><parameter>passwd</parameter>&#160;:</term>
115
 
<listitem><simpara>the password for <parameter>key</parameter>
116
 
</simpara></listitem></varlistentry>
117
 
</variablelist></refsect2>
118
 
<refsect2 id="e-passwords-get-password" role="function">
119
 
<title>e_passwords_get_password ()</title>
120
 
<indexterm zone="e-passwords-get-password"><primary>e_passwords_get_password</primary></indexterm>
121
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_passwords_get_password            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>,
122
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
123
 
<variablelist role="params">
124
 
<varlistentry><term><parameter>component</parameter>&#160;:</term>
125
 
<listitem><simpara>
126
 
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
128
 
<listitem><simpara>the key
129
 
</simpara></listitem></varlistentry>
130
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the password associated with <parameter>key</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.  Caller
131
 
must free the returned password.
132
 
</simpara></listitem></varlistentry>
133
 
</variablelist></refsect2>
134
 
<refsect2 id="e-passwords-forget-password" role="function">
135
 
<title>e_passwords_forget_password ()</title>
136
 
<indexterm zone="e-passwords-forget-password"><primary>e_passwords_forget_password</primary></indexterm>
137
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_forget_password         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>,
138
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
139
 
<para>
140
 
Forgets the password associated with <parameter>key</parameter>, in memory and on disk.</para>
141
 
<variablelist role="params">
142
 
<varlistentry><term><parameter>component</parameter>&#160;:</term>
143
 
<listitem><simpara>
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
146
 
<listitem><simpara>the key
147
 
</simpara></listitem></varlistentry>
148
 
</variablelist></refsect2>
149
 
<refsect2 id="e-passwords-forget-passwords" role="function">
150
 
<title>e_passwords_forget_passwords ()</title>
151
 
<indexterm zone="e-passwords-forget-passwords"><primary>e_passwords_forget_passwords</primary></indexterm>
152
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_forget_passwords        (<parameter><type>void</type></parameter>);</programlisting>
153
 
<para>
154
 
Forgets all cached passwords, in memory and on disk.</para>
155
 
</refsect2>
156
 
<refsect2 id="e-passwords-clear-passwords" role="function">
157
 
<title>e_passwords_clear_passwords ()</title>
158
 
<indexterm zone="e-passwords-clear-passwords"><primary>e_passwords_clear_passwords</primary></indexterm>
159
 
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_passwords_clear_passwords         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *component</parameter>);</programlisting>
160
 
<para>
161
 
Forgets all disk cached passwords for the component.</para>
162
 
<variablelist role="params">
163
 
<varlistentry><term><parameter>component</parameter>&#160;:</term>
164
 
<listitem><simpara>
165
 
</simpara></listitem></varlistentry>
166
 
</variablelist></refsect2>
167
 
<refsect2 id="EPasswordsRememberType" role="enum">
168
 
<title>enum EPasswordsRememberType</title>
169
 
<indexterm zone="EPasswordsRememberType"><primary>EPasswordsRememberType</primary></indexterm>
170
 
<programlisting>typedef enum {
171
 
        E_PASSWORDS_REMEMBER_NEVER,
172
 
        E_PASSWORDS_REMEMBER_SESSION,
173
 
        E_PASSWORDS_REMEMBER_FOREVER,
174
 
        E_PASSWORDS_REMEMBER_MASK = 0xf,
175
 
 
176
 
        /* option bits */
177
 
        E_PASSWORDS_SECRET = 1&lt;&lt;8,
178
 
        E_PASSWORDS_REPROMPT = 1&lt;&lt;9,
179
 
        E_PASSWORDS_ONLINE = 1&lt;&lt;10, /* only ask if we're online */
180
 
        E_PASSWORDS_DISABLE_REMEMBER = 1&lt;&lt;11, /* disable the 'remember password' checkbox */
181
 
        E_PASSWORDS_PASSPHRASE = 1&lt;&lt;12 /* We are asking a passphrase */
182
 
} EPasswordsRememberType;
183
 
</programlisting>
184
 
<para>
185
 
</para></refsect2>
186
 
<refsect2 id="e-passwords-ask-password" role="function">
187
 
<title>e_passwords_ask_password ()</title>
188
 
<indexterm zone="e-passwords-ask-password"><primary>e_passwords_ask_password</primary></indexterm>
189
 
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_passwords_ask_password            (<parameter>const <link linkend="gchar"><type>gchar</type></link> *title</parameter>,
190
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *component_name</parameter>,
191
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
192
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *prompt</parameter>,
193
 
                                                         <parameter><link linkend="EPasswordsRememberType"><type>EPasswordsRememberType</type></link> remember_type</parameter>,
194
 
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> *remember</parameter>,
195
 
                                                         <parameter><link linkend="GtkWindow"><type>GtkWindow</type></link> *parent</parameter>);</programlisting>
196
 
<para>
197
 
Asks the user for a password.</para>
198
 
<variablelist role="params">
199
 
<varlistentry><term><parameter>title</parameter>&#160;:</term>
200
 
<listitem><simpara>title for the password dialog
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><parameter>component_name</parameter>&#160;:</term>
203
 
<listitem><simpara>the name of the component for which we're storing
204
 
the password (e.g. Mail, Addressbook, etc.)
205
 
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
207
 
<listitem><simpara>key to store the password under
208
 
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>prompt</parameter>&#160;:</term>
210
 
<listitem><simpara>prompt string
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>remember_type</parameter>&#160;:</term>
213
 
<listitem><simpara>
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>remember</parameter>&#160;:</term>
216
 
<listitem><simpara>on input, the default state of the remember checkbox.
217
 
on output, the state of the checkbox when the dialog was closed.
218
 
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
220
 
<listitem><simpara>parent window of the dialog, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
221
 
</simpara></listitem></varlistentry>
222
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the password, which the caller must free, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if
223
 
the user cancelled the operation. *<parameter>remember</parameter> will be set if the
224
 
return value is non-<link linkend="NULL:CAPS"><literal>NULL</literal></link> and <parameter>remember_type</parameter> is not
225
 
E_PASSWORDS_DO_NOT_REMEMBER.
226
 
</simpara></listitem></varlistentry>
227
 
</variablelist></refsect2>
228
 
 
229
 
</refsect1>
230
 
 
231
 
</refentry>