Msg.Authorizer

g GObject.GInterface GObject.GInterface Msg.Authorizer Msg.Authorizer GObject.GInterface->Msg.Authorizer

Implementations:

Msg.GoaAuthorizer, Msg.OAuth2Authorizer

Methods

process_request (message)

refresh_authorization (cancellable)

Virtual Methods

do_process_request (message)

do_refresh_authorization (cancellable)

Properties

None

Signals

None

Fields

None

Class Details

class Msg.Authorizer
Bases:

GObject.GInterface

Structure:

Msg.AuthorizerInterface

process_request(message)
Parameters:

message (Soup.Message) – A Soup.Message.

Adds the necessary authorization to message. The type of message can be DELETE, GET and POST.

This method modifies message in place and is thread safe.

refresh_authorization(cancellable)
Parameters:

cancellable (Gio.Cancellable or None) – An optional Gio.Cancellable object, or None.

Raises:

GLib.Error

Returns:

True if the authorizer now has a valid token.

Return type:

bool

Synchronously forces self to refresh any authorization tokens held by it. See msg_authorizer_refresh_authorization_async() for the asynchronous version of this call.

This method is thread safe.

do_process_request(message) virtual
Parameters:

message (Soup.Message) – A Soup.Message.

Adds the necessary authorization to message. The type of message can be DELETE, GET and POST.

This method modifies message in place and is thread safe.

do_refresh_authorization(cancellable) virtual
Parameters:

cancellable (Gio.Cancellable or None) – An optional Gio.Cancellable object, or None.

Returns:

True if the authorizer now has a valid token.

Return type:

bool

Synchronously forces iface to refresh any authorization tokens held by it. See msg_authorizer_refresh_authorization_async() for the asynchronous version of this call.

This method is thread safe.