SignonAuthSession

SignonAuthSession

Synopsis

#define             SIGNON_SESSION_DATA_USERNAME
#define             SIGNON_SESSION_DATA_SECRET
#define             SIGNON_SESSION_DATA_REALM
#define             SIGNON_SESSION_DATA_PROXY
enum                SignonSessionDataUiPolicy;
#define             SIGNON_SESSION_DATA_UI_POLICY
#define             SIGNON_SESSION_DATA_CAPTION
#define             SIGNON_SESSION_DATA_TIMEOUT
#define             SIGNON_SESSION_DATA_WINDOW_ID
#define             SIGNON_SESSION_DATA_RENEW_TOKEN
                    SignonAuthSession;
                    SignonAuthSessionPrivate;
                    SignonAuthSessionClass;
SignonAuthSession * signon_auth_session_new             (gint id,
                                                         const gchar *method_name,
                                                         GError **err);
const gchar *       signon_auth_session_get_method      (SignonAuthSession *self);
void                (*SignonAuthSessionQueryAvailableMechanismsCb)
                                                        (SignonAuthSession *self,
                                                         gchar **mechanisms,
                                                         const GError *error,
                                                         gpointer user_data);
void                signon_auth_session_query_available_mechanisms
                                                        (SignonAuthSession *self,
                                                         const gchar **wanted_mechanisms,
                                                         SignonAuthSessionQueryAvailableMechanismsCb cb,
                                                         gpointer user_data);
void                (*SignonAuthSessionProcessCb)       (SignonAuthSession *self,
                                                         GHashTable *session_data,
                                                         const GError *error,
                                                         gpointer user_data);
void                signon_auth_session_process         (SignonAuthSession *self,
                                                         const GHashTable *session_data,
                                                         const gchar *mechanism,
                                                         SignonAuthSessionProcessCb cb,
                                                         gpointer user_data);
void                signon_auth_session_cancel          (SignonAuthSession *self);

Object Hierarchy

  GObject
   +----SignonAuthSession

Signals

  "state-changed"                                  : Run Last / Action

Description

Details

SIGNON_SESSION_DATA_USERNAME

#define SIGNON_SESSION_DATA_USERNAME      "UserName"


SIGNON_SESSION_DATA_SECRET

#define SIGNON_SESSION_DATA_SECRET        "Secret"


SIGNON_SESSION_DATA_REALM

#define SIGNON_SESSION_DATA_REALM         "Realm"


SIGNON_SESSION_DATA_PROXY

#define SIGNON_SESSION_DATA_PROXY         "NetworkProxy"


enum SignonSessionDataUiPolicy

typedef enum {
    SignonPolicyDefault = 0,       /**< Plugin can decide when to show ui. */
    SignonPolicyRequestPassword,   /**< Force user to enter password. */
    SignonPolicyNoUserInteraction, /**< No ui elements are shown to user. */
    /**
     * UI elements can be shown to the user only when captcha-like security
     * measures are required.
    */
    SignonPolicyValidation,
} SignonSessionDataUiPolicy;


SIGNON_SESSION_DATA_UI_POLICY

#define SIGNON_SESSION_DATA_UI_POLICY     "UiPolicy"


SIGNON_SESSION_DATA_CAPTION

#define SIGNON_SESSION_DATA_CAPTION       "Caption"


SIGNON_SESSION_DATA_TIMEOUT

#define SIGNON_SESSION_DATA_TIMEOUT       "NetworkTimeout"


SIGNON_SESSION_DATA_WINDOW_ID

#define SIGNON_SESSION_DATA_WINDOW_ID     "WindowId"


SIGNON_SESSION_DATA_RENEW_TOKEN

#define SIGNON_SESSION_DATA_RENEW_TOKEN   "RenewToken"


SignonAuthSession

typedef struct _SignonAuthSession SignonAuthSession;


SignonAuthSessionPrivate

typedef struct _SignonAuthSessionPrivate SignonAuthSessionPrivate;


SignonAuthSessionClass

typedef struct {
    GObjectClass parent;
} SignonAuthSessionClass;


signon_auth_session_new ()

SignonAuthSession * signon_auth_session_new             (gint id,
                                                         const gchar *method_name,
                                                         GError **err);

id :

method_name :

err :

Returns :


signon_auth_session_get_method ()

const gchar *       signon_auth_session_get_method      (SignonAuthSession *self);

self :

Returns :


SignonAuthSessionQueryAvailableMechanismsCb ()

void                (*SignonAuthSessionQueryAvailableMechanismsCb)
                                                        (SignonAuthSession *self,
                                                         gchar **mechanisms,
                                                         const GError *error,
                                                         gpointer user_data);

self :

mechanisms :

error :

user_data :


signon_auth_session_query_available_mechanisms ()

void                signon_auth_session_query_available_mechanisms
                                                        (SignonAuthSession *self,
                                                         const gchar **wanted_mechanisms,
                                                         SignonAuthSessionQueryAvailableMechanismsCb cb,
                                                         gpointer user_data);

self :

wanted_mechanisms :

cb :

user_data :


SignonAuthSessionProcessCb ()

void                (*SignonAuthSessionProcessCb)       (SignonAuthSession *self,
                                                         GHashTable *session_data,
                                                         const GError *error,
                                                         gpointer user_data);

self :

session_data :

error :

user_data :


signon_auth_session_process ()

void                signon_auth_session_process         (SignonAuthSession *self,
                                                         const GHashTable *session_data,
                                                         const gchar *mechanism,
                                                         SignonAuthSessionProcessCb cb,
                                                         gpointer user_data);

self :

session_data :

mechanism :

cb :

user_data :


signon_auth_session_cancel ()

void                signon_auth_session_cancel          (SignonAuthSession *self);

self :

Signal Details

The "state-changed" signal

void                user_function                      (SignonAuthSession *signonauthsession,
                                                        gint               arg1,
                                                        gchar             *arg2,
                                                        gpointer           user_data)              : Run Last / Action

signonauthsession :

the object which received the signal.

arg1 :

arg2 :

user_data :

user data set when the signal handler was connected.