From ef401cf42eaf46a4ef9ca22c834c0c019bfdad47 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Tue, 14 Jun 2011 15:35:16 +0100 Subject: [PATCH] moonshot-dbus-server: Document the get_identity IPC interface --- src/moonshot-dbus-server.vala | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/moonshot-dbus-server.vala b/src/moonshot-dbus-server.vala index 6485f61..ace5ba2 100644 --- a/src/moonshot-dbus-server.vala +++ b/src/moonshot-dbus-server.vala @@ -8,6 +8,22 @@ public class MoonshotServer : Object { this.main_window = (MainWindow) window; } + /** + * This is the function used by the GSS mechanism to get the NAI, + * password and certificate of the ID card for the specificated service. + * + * The function will block until the user choose the ID card. + * + * @param nai NAI of the ID Card (optional) + * @param password Password of the ID Card (optional) + * @param service Service application request an ID Card for + * @param nai_out NAI stored in the ID Card + * @param password_out Password stored in the ID Card + * @param certificate Certificate stored in th ID Card + * + * @return true if the user choose a correct ID card for that service, + * false otherwise. + */ public async bool get_identity (string nai, string password, string service, -- 2.1.4