SignonIdentity

SignonIdentity — client side presentation of a credential.

Synopsis

                    SignonIdentityClass;
                    SignonIdentityPrivate;
                    SignonIdentity;
                    SignonIdentityInfo;
void                (*SignonIdentityVoidCb)             (SignonIdentity *self,
                                                         const GError *error,
                                                         gpointer user_data);
typedef             SignonIdentityRemovedCb;
typedef             SignonIdentitySignedOutCb;
typedef             SignonIdentityReferenceAddedCb;
typedef             SignonIdentityReferenceRemovedCb;
enum                SignonIdentityType;
SignonIdentity *    signon_identity_new_from_db         (guint32 id);
SignonIdentity *    signon_identity_new                 ();
const GError *      signon_identity_get_last_error      (SignonIdentity *identity);
SignonAuthSession * signon_identity_create_session      (SignonIdentity *self,
                                                         const gchar *method,
                                                         GError **error);
void                (*SignonIdentityStoreCredentialsCb) (SignonIdentity *self,
                                                         guint32 id,
                                                         const GError *error,
                                                         gpointer user_data);
void                signon_identity_store_credentials_with_info
                                                        (SignonIdentity *self,
                                                         const SignonIdentityInfo *info,
                                                         SignonIdentityStoreCredentialsCb cb,
                                                         gpointer user_data);
void                signon_identity_store_credentials_with_args
                                                        (SignonIdentity *self,
                                                         const gchar *username,
                                                         const gchar *secret,
                                                         const gboolean store_secret,
                                                         const GHashTable *methods,
                                                         const gchar *caption,
                                                         const gchar * const *realms,
                                                         const gchar * const *access_control_list,
                                                         SignonIdentityType type,
                                                         SignonIdentityStoreCredentialsCb cb,
                                                         gpointer user_data);
void                (*SignonIdentityVerifyCb)           (SignonIdentity *self,
                                                         gboolean valid,
                                                         const GError *error,
                                                         gpointer user_data);
void                signon_identity_verify_user         (SignonIdentity *self,
                                                         const gchar *message,
                                                         SignonIdentityVerifyCb cb,
                                                         gpointer user_data);
void                signon_identity_verify_secret       (SignonIdentity *self,
                                                         const gchar *secret,
                                                         SignonIdentityVerifyCb cb,
                                                         gpointer user_data);
void                (*SignonIdentityInfoCb)             (SignonIdentity *self,
                                                         const SignonIdentityInfo *info,
                                                         const GError *error,
                                                         gpointer user_data);
void                signon_identity_query_info          (SignonIdentity *self,
                                                         SignonIdentityInfoCb cb,
                                                         gpointer user_data);
void                signon_identity_remove              (SignonIdentity *self,
                                                         SignonIdentityRemovedCb cb,
                                                         gpointer user_data);
void                signon_identity_signout             (SignonIdentity *self,
                                                         SignonIdentitySignedOutCb cb,
                                                         gpointer user_data);
void                signon_identity_add_reference       (SignonIdentity *self,
                                                         const gchar *reference,
                                                         SignonIdentityReferenceAddedCb cb,
                                                         gpointer user_data);
void                signon_identity_remove_reference    (SignonIdentity *self,
                                                         const gchar *reference,
                                                         SignonIdentityReferenceRemovedCb cb,
                                                         gpointer user_data);
SignonIdentityInfo * signon_identity_info_new           ();
void                signon_identity_info_free           (SignonIdentityInfo *info);
SignonIdentityInfo * signon_identity_info_copy          (const SignonIdentityInfo *other);
gint                signon_identity_info_get_id         (const SignonIdentityInfo *info);
const gchar *       signon_identity_info_get_username   (const SignonIdentityInfo *info);
gboolean            signon_identity_info_get_storing_secret
                                                        (const SignonIdentityInfo *info);
const gchar *       signon_identity_info_get_caption    (const SignonIdentityInfo *info);
const GHashTable *  signon_identity_info_get_methods    (const SignonIdentityInfo *info);
const gchar* const * signon_identity_info_get_realms    (const SignonIdentityInfo *info);
const gchar* const * signon_identity_info_get_access_control_list
                                                        (const SignonIdentityInfo *info);
SignonIdentityType  signon_identity_info_get_identity_type
                                                        (const SignonIdentityInfo *info);
gint                signon_identity_info_get_identity_ref_count
                                                        (const SignonIdentityInfo *info);
void                signon_identity_info_set_username   (SignonIdentityInfo *info,
                                                         const gchar *username);
void                signon_identity_info_set_secret     (SignonIdentityInfo *info,
                                                         const gchar *secret,
                                                         gboolean store_secret);
void                signon_identity_info_set_caption    (SignonIdentityInfo *info,
                                                         const gchar *caption);
void                signon_identity_info_set_method     (SignonIdentityInfo *info,
                                                         const gchar *method,
                                                         const gchar * const *mechanisms);
void                signon_identity_info_remove_method  (SignonIdentityInfo *info,
                                                         const gchar *method);
void                signon_identity_info_set_realms     (SignonIdentityInfo *info,
                                                         const gchar * const *realms);
void                signon_identity_info_set_access_control_list
                                                        (SignonIdentityInfo *info,
                                                         const gchar * const *access_control_list);
void                signon_identity_info_set_identity_type
                                                        (SignonIdentityInfo *info,
                                                         SignonIdentityType type);
void                signon_identity_info_set_identity_ref_count
                                                        (SignonIdentityInfo *info,
                                                         gint ref_count);

Object Hierarchy

  GObject
   +----SignonIdentity

Properties

  "id"                       guint                 : Read / Write

Signals

  "signout"                                        : Run Last / No Recursion / No Hooks

Description

The SignonIdentity represents an database entry for a single identity.

Details

SignonIdentityClass

typedef struct {
    GObjectClass parent_class;
} SignonIdentityClass;


SignonIdentityPrivate

typedef struct _SignonIdentityPrivate SignonIdentityPrivate;


SignonIdentity

typedef struct _SignonIdentity SignonIdentity;


SignonIdentityInfo

typedef struct _SignonIdentityInfo SignonIdentityInfo;


SignonIdentityVoidCb ()

void                (*SignonIdentityVoidCb)             (SignonIdentity *self,
                                                         const GError *error,
                                                         gpointer user_data);

self :

error :

user_data :


SignonIdentityRemovedCb

typedef SignonIdentityVoidCb SignonIdentityRemovedCb;


SignonIdentitySignedOutCb

typedef SignonIdentityVoidCb SignonIdentitySignedOutCb;


SignonIdentityReferenceAddedCb

typedef SignonIdentityVoidCb SignonIdentityReferenceAddedCb;


SignonIdentityReferenceRemovedCb

typedef SignonIdentityVoidCb SignonIdentityReferenceRemovedCb;


enum SignonIdentityType

enum SignonIdentityType {
    SIGNON_TYPE_OTHER = 0,
    SIGNON_TYPE_APP = 1 << 0,
    SIGNON_TYPE_WEB = 1 << 1,
    SIGNON_TYPE_NETWORK = 1 << 2
};


signon_identity_new_from_db ()

SignonIdentity *    signon_identity_new_from_db         (guint32 id);

Construct an identity object associated with an existing identity record.

id :

identity ID.

Returns :

an instance of an SignonIdentity.

signon_identity_new ()

SignonIdentity *    signon_identity_new                 ();

Construct an identity object associated with an existing identity record.

Returns :

an instance of an SignonIdentity.

signon_identity_get_last_error ()

const GError *      signon_identity_get_last_error      (SignonIdentity *identity);

identity :

Returns :


signon_identity_create_session ()

SignonAuthSession * signon_identity_create_session      (SignonIdentity *self,
                                                         const gchar *method,
                                                         GError **error);

Construct an identity object associated with an existing identity record.

self :

self.

method :

method.

error :

error.

Returns :

an instance of an SignonIdentity.

SignonIdentityStoreCredentialsCb ()

void                (*SignonIdentityStoreCredentialsCb) (SignonIdentity *self,
                                                         guint32 id,
                                                         const GError *error,
                                                         gpointer user_data);

self :

id :

error :

user_data :


signon_identity_store_credentials_with_info ()

void                signon_identity_store_credentials_with_info
                                                        (SignonIdentity *self,
                                                         const SignonIdentityInfo *info,
                                                         SignonIdentityStoreCredentialsCb cb,
                                                         gpointer user_data);

self :

info :

cb :

user_data :


signon_identity_store_credentials_with_args ()

void                signon_identity_store_credentials_with_args
                                                        (SignonIdentity *self,
                                                         const gchar *username,
                                                         const gchar *secret,
                                                         const gboolean store_secret,
                                                         const GHashTable *methods,
                                                         const gchar *caption,
                                                         const gchar * const *realms,
                                                         const gchar * const *access_control_list,
                                                         SignonIdentityType type,
                                                         SignonIdentityStoreCredentialsCb cb,
                                                         gpointer user_data);

self :

username :

secret :

store_secret :

methods :

caption :

realms :

access_control_list :

type :

cb :

user_data :


SignonIdentityVerifyCb ()

void                (*SignonIdentityVerifyCb)           (SignonIdentity *self,
                                                         gboolean valid,
                                                         const GError *error,
                                                         gpointer user_data);

self :

valid :

error :

user_data :


signon_identity_verify_user ()

void                signon_identity_verify_user         (SignonIdentity *self,
                                                         const gchar *message,
                                                         SignonIdentityVerifyCb cb,
                                                         gpointer user_data);

self :

message :

cb :

user_data :


signon_identity_verify_secret ()

void                signon_identity_verify_secret       (SignonIdentity *self,
                                                         const gchar *secret,
                                                         SignonIdentityVerifyCb cb,
                                                         gpointer user_data);

self :

secret :

cb :

user_data :


SignonIdentityInfoCb ()

void                (*SignonIdentityInfoCb)             (SignonIdentity *self,
                                                         const SignonIdentityInfo *info,
                                                         const GError *error,
                                                         gpointer user_data);

self :

info :

error :

user_data :


signon_identity_query_info ()

void                signon_identity_query_info          (SignonIdentity *self,
                                                         SignonIdentityInfoCb cb,
                                                         gpointer user_data);

self :

cb :

user_data :


signon_identity_remove ()

void                signon_identity_remove              (SignonIdentity *self,
                                                         SignonIdentityRemovedCb cb,
                                                         gpointer user_data);

Removes correspondent credentials record

self :

cb :

callback

user_data :

user_data.

signon_identity_signout ()

void                signon_identity_signout             (SignonIdentity *self,
                                                         SignonIdentitySignedOutCb cb,
                                                         gpointer user_data);

Makes SignOut

self :

cb :

callback

user_data :

user_data.

signon_identity_add_reference ()

void                signon_identity_add_reference       (SignonIdentity *self,
                                                         const gchar *reference,
                                                         SignonIdentityReferenceAddedCb cb,
                                                         gpointer user_data);

Adds named reference to identity

self :

reference :

reference to be added

cb :

callback

user_data :

user_data.

signon_identity_remove_reference ()

void                signon_identity_remove_reference    (SignonIdentity *self,
                                                         const gchar *reference,
                                                         SignonIdentityReferenceRemovedCb cb,
                                                         gpointer user_data);

Removes named reference from identity

self :

reference :

reference to be removed

cb :

callback

user_data :

user_data.

signon_identity_info_new ()

SignonIdentityInfo * signon_identity_info_new           ();

Returns :


signon_identity_info_free ()

void                signon_identity_info_free           (SignonIdentityInfo *info);

info :


signon_identity_info_copy ()

SignonIdentityInfo * signon_identity_info_copy          (const SignonIdentityInfo *other);

other :

Returns :


signon_identity_info_get_id ()

gint                signon_identity_info_get_id         (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_username ()

const gchar *       signon_identity_info_get_username   (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_storing_secret ()

gboolean            signon_identity_info_get_storing_secret
                                                        (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_caption ()

const gchar *       signon_identity_info_get_caption    (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_methods ()

const GHashTable *  signon_identity_info_get_methods    (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_realms ()

const gchar* const * signon_identity_info_get_realms    (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_access_control_list ()

const gchar* const * signon_identity_info_get_access_control_list
                                                        (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_identity_type ()

SignonIdentityType  signon_identity_info_get_identity_type
                                                        (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_get_identity_ref_count ()

gint                signon_identity_info_get_identity_ref_count
                                                        (const SignonIdentityInfo *info);

info :

Returns :


signon_identity_info_set_username ()

void                signon_identity_info_set_username   (SignonIdentityInfo *info,
                                                         const gchar *username);

info :

username :


signon_identity_info_set_secret ()

void                signon_identity_info_set_secret     (SignonIdentityInfo *info,
                                                         const gchar *secret,
                                                         gboolean store_secret);

info :

secret :

store_secret :


signon_identity_info_set_caption ()

void                signon_identity_info_set_caption    (SignonIdentityInfo *info,
                                                         const gchar *caption);

info :

caption :


signon_identity_info_set_method ()

void                signon_identity_info_set_method     (SignonIdentityInfo *info,
                                                         const gchar *method,
                                                         const gchar * const *mechanisms);

info :

method :

mechanisms :


signon_identity_info_remove_method ()

void                signon_identity_info_remove_method  (SignonIdentityInfo *info,
                                                         const gchar *method);

info :

method :


signon_identity_info_set_realms ()

void                signon_identity_info_set_realms     (SignonIdentityInfo *info,
                                                         const gchar * const *realms);

info :

realms :


signon_identity_info_set_access_control_list ()

void                signon_identity_info_set_access_control_list
                                                        (SignonIdentityInfo *info,
                                                         const gchar * const *access_control_list);

info :

access_control_list :


signon_identity_info_set_identity_type ()

void                signon_identity_info_set_identity_type
                                                        (SignonIdentityInfo *info,
                                                         SignonIdentityType type);

info :

type :


signon_identity_info_set_identity_ref_count ()

void                signon_identity_info_set_identity_ref_count
                                                        (SignonIdentityInfo *info,
                                                         gint ref_count);

info :

ref_count :

Property Details

The "id" property

  "id"                       guint                 : Read / Write

Set/Get Identity ID.

Default value: 0

Signal Details

The "signout" signal

void                user_function                      (SignonIdentity *signonidentity,
                                                        gpointer        user_data)           : Run Last / No Recursion / No Hooks

signonidentity :

the object which received the signal.

user_data :

user data set when the signal handler was connected.