ewk_auth_request.h File Reference

Describes the Ewk Authentication Request API. More...

#include <Eina.h>

Go to the source code of this file.

Typedefs
typedef struct EwkObject	Ewk_Auth_Request

Functions
EAPI const char *	ewk_auth_request_suggested_username_get (const Ewk_Auth_Request *request)
EAPI Eina_Bool	ewk_auth_request_retrying_get (const Ewk_Auth_Request *request)
EAPI const char *	ewk_auth_request_realm_get (const Ewk_Auth_Request *request)
EAPI const char *	ewk_auth_request_host_get (const Ewk_Auth_Request *request)
EAPI Eina_Bool	ewk_auth_request_cancel (Ewk_Auth_Request *request)
EAPI Eina_Bool	ewk_auth_request_authenticate (Ewk_Auth_Request *request, const char *username, const char *password)

Detailed Description

Describes the Ewk Authentication Request API.

Typedef Documentation

typedef struct EwkObject Ewk_Auth_Request

Declare Ewk_Auth_Request as Ewk_Object.

See also

Ewk_Object

Function Documentation

EAPI Eina_Bool ewk_auth_request_authenticate	(	Ewk_Auth_Request *	request,
		const char *	username,
		const char *	password
	)

Set credential for the authentication request.

Parameters

request

request object to update

Returns

EINA_TRUE if the credential was successfuly sent, EINA_FALSE otherwise.

EAPI Eina_Bool ewk_auth_request_cancel

(

Ewk_Auth_Request *

request

)

Cancels the authentication request.

Parameters

request

request object to cancel

Returns

EINA_TRUE if successful, EINA_FALSE otherwise

EAPI const char* ewk_auth_request_host_get

(

const Ewk_Auth_Request *

request

)

Queries the host requiring the authentication.

Parameters

request

request object to query

Returns

the host pointer, that may be NULL. This pointer is guaranteed to be eina_stringshare, so whenever possible save yourself some cpu cycles and use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()

EAPI const char* ewk_auth_request_realm_get

(

const Ewk_Auth_Request *

request

)

Queries the authentication realm.

Parameters

request

request object to query

Returns

the realm pointer, that may be NULL. This pointer is guaranteed to be eina_stringshare, so whenever possible save yourself some cpu cycles and use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()

EAPI Eina_Bool ewk_auth_request_retrying_get

(

const Ewk_Auth_Request *

request

)

Queries if this an authentication attempt retrying.

Parameters

request

request object to query

Returns

EINA_TRUE if this is not the first authentication attempt and we are trying, EINA_FALSE otherwise.

EAPI const char* ewk_auth_request_suggested_username_get

(

const Ewk_Auth_Request *

request

)

Queries the suggested username to be used for authenticating.

Parameters

request

request object to query

Returns

the username pointer, that may be NULL. This pointer is guaranteed to be eina_stringshare, so whenever possible save yourself some cpu cycles and use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()