Foundry.AuthProvider

g Foundry.AuthProvider Foundry.AuthProvider Foundry.Contextual Foundry.Contextual Foundry.Contextual->Foundry.AuthProvider GObject.GInterface GObject.GInterface Json.Serializable Json.Serializable GObject.GInterface->Json.Serializable GObject.Object GObject.Object GObject.Object->Foundry.Contextual Json.Serializable->Foundry.Contextual

Subclasses:

Foundry.TtyAuthProvider

Methods

Inherited:

Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)

Structs:

GObject.ObjectClass (5)

class

new_for_context (context)

prompt (input)

Virtual Methods

Inherited:

GObject.Object (7), Json.Serializable (5)

do_prompt (input)

Properties

Inherited:

Foundry.Contextual (1)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

Foundry.Contextual

r

Class Details

class Foundry.AuthProvider(**kwargs)
Bases:

Foundry.Contextual

Abstract:

Yes

Structure:

Foundry.AuthProviderClass

Abstract class for requesting credentials from a user.

This abstract class can be implemented to provide an interface for the user to provide credentials. Applications are encouraged to provide this so that password input and similar is possible.

classmethod new_for_context(context)
Parameters:

context (Foundry.Context) – a [class`Foundry`.Context]

Return type:

Foundry.AuthProvider or None

Creates a new [class`Foundry`.AuthProvider] for context.

prompt(input)
Parameters:

input (Foundry.Input) – a [class`Foundry`.Input]

Returns:

a [class`Dex`.Future] that resolves to any value when the prompt has been completed by the user.

Return type:

Dex.Future

do_prompt(input) virtual
Parameters:

input (Foundry.Input) – a [class`Foundry`.Input]

Returns:

a [class`Dex`.Future] that resolves to any value when the prompt has been completed by the user.

Return type:

Dex.Future