← Back to branch summary

~mvo/ubuntu-sso-client/strawman-lp711413

« back to all changes in this revision

Viewing changes to README

  • Committer: Natalia B. Bidart
  • Date: 2010-12-09 20:00:20 UTC
  • mto: This revision was merged to the branch mainline in revision 660.
  • Revision ID: natalia.bidart@canonical.com-20101209200020-8i07nrryt7w93csk
Aspell check.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
6
6
When requesting a set of credentials for a given application, if those
7
7
credentials are not yet present on the user's keyring, the user is presented
8
8
with a GUI to either register a new account, or log in using an existing
9
 
account by means of the Ubuntu SSO webservice.
 
9
account by means of the Ubuntu SSO web service.
10
10
 
11
11
Since version 1.1.5, this service does not depend on the gnome-keyring
12
12
service, but on any keyring service that implements the freedesktop secrets
27
27
required to handle results specially, where necessary.
28
28
 
29
29
They all return information to the caller through signals, since all the
30
 
operations (either against the keyring, or against the SSO webservice) are
 
30
operations (either against the keyring, or against the SSO web service) are
31
31
blocking, and so the Ubuntu SSO API is entirely asynchronous.
32
32
 
33
33
NOTE: formerly, the {{{ApplicationCredentials}}} interface was implemented
89
89
 * 'app_name': will be displayed in the GUI header (so it should be human
90
90
 readable), plus it will be used to find/build/clear tokens. Special attention
91
91
 must be paid to this value since if it collides with some other app name,
92
 
 return signals may be missleading because the identifier is the application
 
92
 return signals may be misleading because the identifier is the application
93
93
 name.
94
94
 
95
95
The second parameter 'ui_settings' can contain any of the following (none is
131
131
 
132
132
So, it will try to fetch the credentials from the user's keyring for
133
133
"app_name", and will emit the {{{CredentialsFound}}} signal if found. If
134
 
exisitng credentials are not found, it will open a graphical dialog to let the
 
134
existing credentials are not found, it will open a graphical dialog to let the
135
135
user log in into an existing SSO account. Once the user is successfully logged
136
136
in, the newly acquired credentials for "app_name" will be stored in the keyring
137
137
and will be returned to the caller through the {{{CredentialsFound}}} signal.
173
173
==== AuthorizationDenied(String app_name) ====
174
174
 
175
175
Emitted when the user was presented with a graphical interface and s/he
176
 
cancelled the request for login and/or register by clicking on a 'Cancel'
 
176
canceled the request for login and/or register by clicking on a 'Cancel'
177
177
button before the process was completed.
178
178
 
179
179
 * "app_name" is the application name as passed to the called method.
199
199
 
200
200
Emitted when the credentials for "app_name" were successfully removed from the
201
201
user's keyring. Note that if an application requested the removal of
202
 
non-existent credentials, this signals will be emitted if no error ocurred.
 
202
non-existent credentials, this signals will be emitted if no error occurred.
203
203
 
204
204
 * "app_name" is the application name as passed to the called method.
205
205