Interface

MsgAuthorizer

Description

interface Msg.Authorizer : GObject.Object
No description available.

Prerequisite

In order to implement Authorizer, your type must inherit fromGObject.

Instance methods

msg_authorizer_process_request

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

msg_authorizer_refresh_authorization

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

Interface structure

struct MsgAuthorizerInterface {
  GTypeInterface parent_iface;
  void (* process_request) (
    MsgAuthorizer* iface,
    SoupMessage* message
  );
  gboolean (* refresh_authorization) (
    MsgAuthorizer* iface,
    GCancellable* cancellable,
    GError** error
  );
  
}

Interface structure for MsgAuthorizer. All methods should be thread safe.

Interface members
parent_iface
GTypeInterface
 

The parent interface.

process_request
void (* process_request) (
    MsgAuthorizer* iface,
    SoupMessage* message
  )
 

A method to append authorization headers to a SoupMessage. Types of messages include DELETE, GET and POST.

refresh_authorization
gboolean (* refresh_authorization) (
    MsgAuthorizer* iface,
    GCancellable* cancellable,
    GError** error
  )
 

A synchronous method to force a refresh of any authorization tokens held by the authorizer. It should return TRUE on success. An asynchronous version will be defined by invoking this in a thread.

Virtual methods

Msg.Authorizer.process_request

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

Msg.Authorizer.refresh_authorization

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