Top | ![]() |
![]() |
![]() |
![]() |
This file provides commonly used parameters for authentication sessions. For each of those a getter and setter is defined, on GSignondSessionData container. The plugins may not use all of these parameters, and they commonly require additional, custom parameters which are set using GSignondDictionary setters with explicit key string.
GSignondSessionData *
gsignond_session_data_new (void
);
Creates a new instance of GSignondSessionData.
GSignondSessionData *
gsignond_session_data_new_from_variant
(GVariant *variant
);
Converts the GVariant to GSignondSessionData. This is useful for example if
the dictionary needs to be deserialized, or if it's contained in another
GSignondSessionData and has been retrieved using gsignond_dictionary_get()
.
GSignondSessionData *
gsignond_session_data_copy (GSignondSessionData *other
);
Creates a copy of the dictionary session data.
const gchar *
gsignond_session_data_get_username (GSignondSessionData *data
);
A getter for a username associated with the authentication session.
void gsignond_session_data_set_username (GSignondSessionData *data
,const gchar *username
);
A setter for a username associated with the authentication session.
const gchar *
gsignond_session_data_get_secret (GSignondSessionData *data
);
A getter for a secret (e.g. a password) associated with the authentication session.
void gsignond_session_data_set_secret (GSignondSessionData *data
,const gchar *secret
);
A setter for a secret (e.g. a password) associated with the authentication session.
const gchar *
gsignond_session_data_get_realm (GSignondSessionData *data
);
A getter for a realm associated with the authentication session.
void gsignond_session_data_set_realm (GSignondSessionData *data
,const gchar *realm
);
A setter for a realm associated with the authentication session.
GSequence *
gsignond_session_data_get_allowed_realms
(GSignondSessionData *data
);
A getter for a list of realms allowed for the identity use.
[skip]
void gsignond_session_data_set_allowed_realms (GSignondSessionData *data
,GSequence *realms
);
A setter for a list of realms allowed for the identity use.
const gchar *
gsignond_session_data_get_caption (GSignondSessionData *data
);
A getter for a caption associated with the authentication session. Caption tells the user which application/credentials/provider is requestion authentication.
void gsignond_session_data_set_caption (GSignondSessionData *data
,const gchar *caption
);
A setter for a caption associated with the authentication session. Caption tells the user which application/credentials/provider is requestion authentication.
gboolean gsignond_session_data_get_renew_token (GSignondSessionData *data
,gboolean *renew_token
);
A getter for a renew token property associated with the authentication session. This property tells the plugin to discard any cached tokens and start the authentication process anew.
void gsignond_session_data_set_renew_token (GSignondSessionData *data
,gboolean renew_token
);
A setter for a renew token property associated with the authentication session. This property tells the plugin to discard any cached tokens and start the authentication process anew.
gboolean gsignond_session_data_get_ui_policy (GSignondSessionData *data
,GSignondUiPolicy *ui_policy
);
A getter for UI policy setting associated with the authentication session. The UI policy indicates how the authentication plugin should interact with the user.
void gsignond_session_data_set_ui_policy (GSignondSessionData *data
,GSignondUiPolicy ui_policy
);
A getter for UI policy setting associated with the authentication session. The UI policy indicates how the authentication plugin should interact with the user.
const gchar *
gsignond_session_data_get_network_proxy
(GSignondSessionData *data
);
A getter for a network proxy setting associated with the authentication session. If this property is not set, the default system proxy settings should be used.
void gsignond_session_data_set_network_proxy (GSignondSessionData *data
,const gchar *network_proxy
);
A setter for a network proxy setting associated with the authentication session. If this property is not set, the default system proxy settings should be used.
gboolean gsignond_session_data_get_network_timeout (GSignondSessionData *data
,guint32 *network_timeout
);
A getter for a network timeout setting associated with the authentication session. This can be used to change the default timeout in case of unresponsive servers.
void gsignond_session_data_set_network_timeout (GSignondSessionData *data
,guint32 network_timeout
);
A setter for a network timeout setting associated with the authentication session. This can be used to change the default timeout in case of unresponsive servers.
gboolean gsignond_session_data_get_window_id (GSignondSessionData *data
,guint32 *window_id
);
A getter for a window id setting associated with the authentication session. This can be used to embed the user interaction window produced by the authentication session into an application window.
void gsignond_session_data_set_window_id (GSignondSessionData *data
,guint32 window_id
);
A setter for a window id setting associated with the authentication session. This can be used to embed the user interaction window produced by the authentication session into an application window.
Policy setting to define how plugins should handle interaction with the user.