QtNetwork.QAuthenticator Class Reference

The QAuthenticator class provides an authentication object. More...

Inheritance diagram for QtNetwork.QAuthenticator:

Collaboration diagram for QtNetwork.QAuthenticator:

Public Member Functions
override bool	Equals (object o)
override int	GetHashCode ()
	QAuthenticator ()
	QAuthenticator (QAuthenticator other)
virtual void	CreateProxy ()
new void	Detach ()
new bool	IsNull ()
new object	Option (string opt)
new System.Collections.Generic.Dictionary < System.String, System.Object >	Options ()
new string	Realm ()
new void	SetOption (string opt, object value)
new void	Dispose ()

Static Public Member Functions
static bool	operator!= (QAuthenticator arg1, QAuthenticator arg2)
static bool	operator== (QAuthenticator arg1, QAuthenticator arg2)

Protected Member Functions
	QAuthenticator (System.Type dummy)

Protected Attributes
SmokeInvocation	interceptor

Properties
new string	Password [get, set]
new string	User [get, set]
virtual System.IntPtr	SmokeObject [get, set]

Detailed Description

The QAuthenticator class provides an authentication object.

The QAuthenticator class is usually used in the authenticationRequired() and proxyAuthenticationRequired() signals of QNetworkAccessManager and QAbstractSocket. The class provides a way to pass back the required authentication information to the socket when accessing services that require authentication.

QAuthenticator supports the following authentication methods:

Basic

NTLM version 2

Digest-MD5

Options

In addition to the username and password required for authentication, a QAuthenticator object can also contain additional options. The options() function can be used to query incoming options sent by the server; the setOption() function can be used to set outgoing options, to be processed by the authenticator calculation. The options accepted and provided depend on the authentication type (see method()).

The following tables list known incoming options as well as accepted outgoing options. The list of incoming options is not exhaustive, since servers may include additional information at any time. The list of outgoing options is exhaustive, however, and no unknown options will be treated or sent back to the server.

Basic

OptionDirectionDescription

realm Incoming Contains the realm of the authentication, the same as realm()

The Basic authentication mechanism supports no outgoing options.

NTLM version 2

The NTLM authentication mechanism currently supports no incoming or outgoing options.

Digest-MD5

OptionDirectionDescription

realm Incoming Contains the realm of the authentication, the same as realm()

The Digest-MD5 authentication mechanism supports no outgoing options.

See also QSslSocket.

Constructor & Destructor Documentation

QtNetwork.QAuthenticator.QAuthenticator ( System.Type  dummy )

protected

QtNetwork.QAuthenticator.QAuthenticator

(

)

Constructs an empty authentication object

QtNetwork.QAuthenticator.QAuthenticator

(

QAuthenticator

other

)

Constructs a copy of other.

Member Function Documentation

virtual void QtNetwork.QAuthenticator.CreateProxy ( )

virtual

new void QtNetwork.QAuthenticator.Detach

(

)

new void QtNetwork.QAuthenticator.Dispose

(

)

override bool QtNetwork.QAuthenticator.Equals

(

object

o

)

override int QtNetwork.QAuthenticator.GetHashCode

(

)

new bool QtNetwork.QAuthenticator.IsNull

(

)

Returns true if the authenticator is null.

static bool QtNetwork.QAuthenticator.operator!= ( QAuthenticator  arg1, QAuthenticator  arg2  )

static

Returns true if this authenticator is different from other; otherwise returns false.

static bool QtNetwork.QAuthenticator.operator== ( QAuthenticator  arg1, QAuthenticator  arg2  )

static

Returns true if this authenticator is identical to other; otherwise returns false.

new object QtNetwork.QAuthenticator.Option

(

string

opt

)

Returns the value related to option opt if it was set by the server. See QAuthenticator::Options for more information on incoming options. If option opt isn't found, an invalid QVariant will be returned.

This function was introduced in Qt 4.7.

See also setOption(), options(), and QAuthenticator::Options.

new System.Collections.Generic.Dictionary<System.String,System.Object> QtNetwork.QAuthenticator.Options

(

)

Returns all incoming options set in this QAuthenticator object by parsing the server reply. See QAuthenticator::Options for more information on incoming options.

This function was introduced in Qt 4.7.

See also option() and QAuthenticator::Options.

new string QtNetwork.QAuthenticator.Realm

(

)

returns the realm requiring authentication.

new void QtNetwork.QAuthenticator.SetOption	(	string	opt,
		object	value
	)

Sets the outgoing option opt to value value. See QAuthenticator::Options for more information on outgoing options.

This function was introduced in Qt 4.7.

See also options(), option(), and QAuthenticator::Options.

Member Data Documentation

SmokeInvocation QtNetwork.QAuthenticator.interceptor

protected

Property Documentation

new string QtNetwork.QAuthenticator.Password

getset

returns the password used for authentication.

Sets the password used for authentication.

virtual System.IntPtr QtNetwork.QAuthenticator.SmokeObject

getset

new string QtNetwork.QAuthenticator.User

getset

returns the user used for authentication.

Sets the user used for authentication.