WockySaslAuth

## WockySaslAuth WockySaslAuth |

## Synopsis

                        WockySaslAuth;
                        WockySaslAuthClass;
                        WockySaslAuthPrivate;
    WockySaslAuth *     wocky_sasl_auth_new                 (const gchar *server,
                                                             const gchar *username,
                                                             const gchar *password,
                                                             WockyXmppConnection *connection,
                                                             WockyAuthRegistry *auth_registry);
    void                wocky_sasl_auth_add_handler         (WockySaslAuth *sasl,
                                                             WockyAuthHandler *handler);
    void                wocky_sasl_auth_authenticate_async  (WockySaslAuth *sasl,
                                                             WockyStanza *features,
                                                             gboolean allow_plain,
                                                             gboolean is_secure,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            wocky_sasl_auth_authenticate_finish (WockySaslAuth *sasl,
                                                             GAsyncResult *result,
                                                             GError **error);

## Object Hierarchy

      GObject
       +----WockySaslAuth

## Properties

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

## Description

## Details

### WockySaslAuth

    typedef struct _WockySaslAuth WockySaslAuth;

### WockySaslAuthClass

    typedef struct {
    } WockySaslAuthClass;

The class of a WockySaslAuth.

### WockySaslAuthPrivate

    typedef struct _WockySaslAuthPrivate WockySaslAuthPrivate;

### wocky_sasl_auth_new ()

    WockySaslAuth *     wocky_sasl_auth_new                 (const gchar *server,
                                                             const gchar *username,
                                                             const gchar *password,
                                                             WockyXmppConnection *connection,
                                                             WockyAuthRegistry *auth_registry);

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

### wocky_sasl_auth_add_handler ()

    void                wocky_sasl_auth_add_handler         (WockySaslAuth *sasl,
                                                             WockyAuthHandler *handler);

`sasl` : |
`handler` : |

### wocky_sasl_auth_authenticate_async ()

    void                wocky_sasl_auth_authenticate_async  (WockySaslAuth *sasl,
                                                             WockyStanza *features,
                                                             gboolean allow_plain,
                                                             gboolean is_secure,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

`sasl` : |
`features` : |
`allow_plain` : |
`is_secure` : |
`cancellable` : |
`callback` : |
`user_data` : |

### wocky_sasl_auth_authenticate_finish ()

    gboolean            wocky_sasl_auth_authenticate_finish (WockySaslAuth *sasl,
                                                             GAsyncResult *result,
                                                             GError **error);

`sasl` : |
`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 `"server"` property

      "server"                   gchar*                : Read / Write / Construct

The name of the server.

Default value: NULL

### The `"username"` property

      "username"                 gchar*                : Write / Construct

The username to authenticate with.

Default value: NULL