Back to Seed Clases

Soup

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Soup.Auth

Class Soup.Auth

Import line:	Soup = imports.gi.Soup;
GIR File:	Soup-2.4.gir
C documentation:	SoupAuth
Class :	Auth
Extends:	GObject.Object

The abstract base class for handling authentication. Specific HTTP
Authentication mechanisms are implemented by its subclasses, but
applications never need to be aware of the specific subclasses
being used.

Properties
Properties		Defined By
	host : String	Soup.Auth
	is_authenticated : gboolean read only	Soup.Auth
	is_for_proxy : gboolean	Soup.Auth
	parent : GObject.Object read only	Soup.Auth
	realm : String	Soup.Auth
	realm : String read only	Soup.Auth
	scheme_name : String read only	Soup.Auth

Methods / Constructors
Method / Constructor		Defined By
	new Soup.Auth (Object *properties) Create a new Soup.Auth Create a new Soup.Auth Parameters: Object properties*
	new Soup.Auth.c_new (Number *type, Message msg, String auth_header) : Soup.Auth Create a new Soup.Auth Create a new Soup.Auth Parameters: Number type* Required (not null) the type of auth to create (a subtype of SoupAuth) Soup.Message msg Required (not null) the SoupMessage the auth is being created for String auth_header Required (not null) the WWW-Authenticate/Proxy-Authenticate header Returns: Soup.Auth the new SoupAuth, or NULL if it could not be
	authenticate (String *username, String password) : none Call this on an auth to authenticate it; normally this will cause the auth's message to be requeued with the new authentication info. Call this on an auth to authenticate it; normally this will cause the auth's message to be requeued with the new authentication info. This does not cause the password to be saved to persistent storage; see soup_auth_save_password() for that. Parameters: String username* Required (not null) the username provided by the user or client String password Required (not null) the password provided by the user or client Returns: none	Soup.Auth
	get_authorization (Message *msg) : String Generates an appropriate "Authorization" header for msg. Generates an appropriate "Authorization" header for msg. (The session will only call this if soup_auth_is_authenticated() returned TRUE.) Parameters: Soup.Message msg* Required (not null) the SoupMessage to be authorized Returns: String the "Authorization" header, which must be freed.	Soup.Auth
	get_host () : String Returns the host that auth is associated with. Returns the host that auth is associated with. Returns: String the hostname	Soup.Auth
	get_info () : String Gets an opaque identifier for auth, for use as a hash key or the like. Gets an opaque identifier for auth, for use as a hash key or the like. SoupAuth objects from the same server with the same identifier refer to the same authentication domain (eg, the URLs associated with them take the same usernames and passwords). Returns: String the identifier	Soup.Auth
	get_protection_space (URI *source_uri) : Array Returns a list of paths on the server which auth* extends over. Returns a list of paths on the server which auth extends over. (All subdirectories of these paths are also assumed to be part of auth's protection space, unless otherwise discovered not to be.) paths, which can be freed with soup_auth_free_protection_space(). Parameters: Soup.URI source_uri Required (not null) the URI of the request that auth was generated in response to. Returns: Array the list of	Soup.Auth
	get_realm () : String Returns auth's realm. Returns auth's realm. This is an identifier that distinguishes separate authentication spaces on a given server, and may be some string that is meaningful to the user. (Although it is probably not localized.) Returns: String the realm name	Soup.Auth
	get_scheme_name () : String Returns auth's scheme name. Returns auth's scheme name. (Eg, "Basic", "Digest", or "NTLM") Returns: String the scheme name	Soup.Auth
	is_authenticated () : gboolean Tests if auth has been given a username and password Tests if auth has been given a username and password Returns: gboolean TRUE if auth has been given a username and password	Soup.Auth
	is_for_proxy () : gboolean Tests whether or not auth is associated with a proxy server rather than an "origin" server. Tests whether or not auth is associated with a proxy server rather than an "origin" server. Returns: gboolean TRUE or FALSE	Soup.Auth
	update (Message *msg, String auth_header) : gboolean Updates auth* with the information from msg and auth_header, possibly un-authenticating it. Updates auth with the information from msg and auth_header, possibly un-authenticating it. As with soup_auth_new(), this is normally only used by SoupSession. unauthenticated) SoupAuth. FALSE if something about auth_params could not be parsed or incorporated into auth at all. Parameters: Soup.Message msg Required (not null) the SoupMessage auth is being updated for String auth_header Required (not null) the WWW-Authenticate/Proxy-Authenticate header Returns: gboolean TRUE if auth is still a valid (but potentially	Soup.Auth

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	save_password (Auth *self, String object, String p0) : none Parameters: Soup.Auth self* String object String p0 Returns: {none}	Soup.Auth

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Soup.Session Signal	authenticate (Session *self, Message object*, Auth p0, gboolean p1) : none

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:16:52 GMT+0800 (HKT)