WockyJabberAuth

## WockyJabberAuth WockyJabberAuth |

## Synopsis

                        WockyJabberAuth;
                        WockyJabberAuthClass;
                        WockyJabberAuthPrivate;
    WockyJabberAuth *   wocky_jabber_auth_new               (const gchar *server,
                                                             const gchar *username,
                                                             const gchar *resource,
                                                             const gchar *password,
                                                             WockyXmppConnection *connection,
                                                             WockyAuthRegistry *auth_registry);
    void                wocky_jabber_auth_add_handler       (WockyJabberAuth *self,
                                                             WockyAuthHandler *handler);
    void                wocky_jabber_auth_authenticate_async
                                                            (WockyJabberAuth *self,
                                                             gboolean allow_plain,
                                                             gboolean is_secure,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            wocky_jabber_auth_authenticate_finish
                                                            (WockyJabberAuth *self,
                                                             GAsyncResult *result,
                                                             GError **error);

## Object Hierarchy

      GObject
       +----WockyJabberAuth

## Properties

      "auth-registry"            WockyAuthRegistry*    : Read / Write / Construct Only
      "connection"               WockyXmppConnection*  : Read / Write / Construct Only
      "password"                 gchar*                : Write / Construct
      "resource"                 gchar*                : Write / Construct
      "session-id"               gchar*                : Read / Write / Construct
      "username"                 gchar*                : Write / Construct

## Description

## Details

### WockyJabberAuth

    typedef struct _WockyJabberAuth WockyJabberAuth;

### WockyJabberAuthClass

    typedef struct {
    } WockyJabberAuthClass;

The class of a WockyJabberAuth.

### WockyJabberAuthPrivate

    typedef struct _WockyJabberAuthPrivate WockyJabberAuthPrivate;

### wocky_jabber_auth_new ()

    WockyJabberAuth *   wocky_jabber_auth_new               (const gchar *server,
                                                             const gchar *username,
                                                             const gchar *resource,
                                                             const gchar *password,
                                                             WockyXmppConnection *connection,
                                                             WockyAuthRegistry *auth_registry);

`server` : |
`username` : |
`resource` : |
`password` : |
`connection` : |
`auth_registry` : |
Returns : |

### wocky_jabber_auth_add_handler ()

    void                wocky_jabber_auth_add_handler       (WockyJabberAuth *self,
                                                             WockyAuthHandler *handler);

`self` : |
`handler` : |

### wocky_jabber_auth_authenticate_async ()

    void                wocky_jabber_auth_authenticate_async
                                                            (WockyJabberAuth *self,
                                                             gboolean allow_plain,
                                                             gboolean is_secure,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

`self` : |
`allow_plain` : |
`is_secure` : |
`cancellable` : |
`callback` : |
`user_data` : |

### wocky_jabber_auth_authenticate_finish ()

    gboolean            wocky_jabber_auth_authenticate_finish
                                                            (WockyJabberAuth *self,
                                                             GAsyncResult *result,
                                                             GError **error);

`self` : |
`result` : |
`error` : |
Returns : |

## Property Details

### The `"auth-registry"` property

      "auth-registry"            WockyAuthRegistry*    : Read / Write / Construct Only

Authentication Registry.

### The `"connection"` property

      "connection"               WockyXmppConnection*  : Read / Write / Construct Only

The Xmpp connection to user.

### The `"password"` property

      "password"                 gchar*                : Write / Construct

The password to authenticate with.

Default value: NULL

### The `"resource"` property

      "resource"                 gchar*                : Write / Construct

The XMPP resource to bind to.

Default value: NULL

### The `"session-id"` property

      "session-id"               gchar*                : Read / Write / Construct

The XMPP session ID.

Default value: NULL

### The `"username"` property

      "username"                 gchar*                : Write / Construct

The username to authenticate with.

Default value: NULL