Soup.AuthDomainBasic

Subclasses:

None

Methods

Inherited:

Soup.AuthDomain (9), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

set_auth_callback (callback, *user_data)

Virtual Methods

Inherited:

Soup.AuthDomain (3), GObject.Object (7)

Properties

Inherited:

Soup.AuthDomain (6)

Name	Type	Flags	Short Description
auth-callback	int	r/w	Password-checking callback
auth-data	int	r/w	Data to pass to authentication callback

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Soup.AuthDomainBasic(**kwargs)

Bases:

Soup.AuthDomain

Abstract:

No

Structure:

Soup.AuthDomainBasicClass

Server-side “Basic” authentication.

Soup.AuthDomainBasic handles the server side of HTTP “Basic” (ie, cleartext password) authentication.

set_auth_callback(callback, *user_data)

Parameters:

• callback (Soup.AuthDomainBasicAuthCallback) – the callback

• user_data (object or None) – data to pass to auth_callback

Sets the callback that self will use to authenticate incoming requests.

For each request containing authorization, self will invoke the callback, and then either accept or reject the request based on callback's return value.

You can also set the auth callback by setting the [property`AuthDomainBasic`:py:data::auth-callback<Soup.AuthDomainBasic.props.auth_callback>] and [property`AuthDomainBasic`:py:data::auth-data<Soup.AuthDomainBasic.props.auth_data>] properties, which can also be used to set the callback at construct time.

Property Details

Soup.AuthDomainBasic.props.auth_callback

Name:

auth-callback

Type:

int

Default Value:

None

Flags:

READABLE, WRITABLE

The [callback`AuthDomainBasicAuthCallback`].

Soup.AuthDomainBasic.props.auth_data

Name:

auth-data

Type:

int

Default Value:

None

Flags:

READABLE, WRITABLE

The data to pass to the [callback`AuthDomainBasicAuthCallback`].