Fwupd.Request¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Fwupd.Codec (21)
Structs:: GObject.ObjectClass (5)

class	`flag_from_string` (flag)
class	`flag_to_string` (flag)
class	`kind_from_string` (kind)
class	`kind_to_string` (kind)
class	`new` ()
	`add_flag` (flag)
	`emit_invalidate` ()
	`get_created` ()
	`get_device_id` ()
	`get_flags` ()
	`get_id` ()
	`get_image` ()
	`get_kind` ()
	`get_message` ()
	`has_flag` (flag)
	`remove_flag` (flag)
	`set_created` (created)
	`set_device_id` (device_id)
	`set_flags` (flags)
	`set_id` (id)
	`set_image` (image)
	`set_kind` (kind)
	`set_message` (message)

Virtual Methods¶

Inherited:: GObject.Object (7), Fwupd.Codec (7)

do_invalidate ()

Properties¶

Name	Type	Flags
`device-id`	`str`	r/w
`flags`	`int`	r/w
`id`	`str`	r/w
`image`	`str`	r/w
`kind`	`int`	r/w
`message`	`str`	r/w

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`invalidate`	The `::invalidate` signal is emitted when the request is no longer valid, and any visible UI components should be hidden.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Fwupd.Request(**kwargs)¶

Bases:: GObject.Object, Fwupd.Codec
Abstract:: No
Structure:: Fwupd.RequestClass

A user request from the device.

See also: [class`FwupdDevice`]

classmethod flag_from_string(flag)[source]¶

Parameters:: flag (str or None) – a string, e.g. none
Returns:: enumerated value
Return type:: Fwupd.RequestFlags

Converts a string to an enumerated request flag.

New in version 1.8.6.

classmethod flag_to_string(flag)[source]¶

Parameters:: flag (Fwupd.RequestFlags) – a request flag, e.g. Fwupd.RequestFlags.NONE
Returns:: identifier string
Return type:: str

Converts an enumerated request flag to a string.

New in version 1.8.6.

classmethod kind_from_string(kind)[source]¶

Parameters:: kind (str or None) – a string, e.g. immediate
Returns:: enumerated value
Return type:: Fwupd.RequestKind

Converts a string to an enumerated update message kind.

New in version 1.6.2.

classmethod kind_to_string(kind)[source]¶

Parameters:: kind (Fwupd.RequestKind) – a update message kind, e.g. Fwupd.RequestKind.IMMEDIATE
Returns:: identifier string
Return type:: str

Converts an enumerated update message kind to a string.

New in version 1.6.2.

classmethod new()[source]¶

Returns:: a new Fwupd.Request
Return type:: Fwupd.Request

Creates a new request.

New in version 1.6.2.

add_flag(flag)[source]¶

Parameters:: flag (Fwupd.RequestFlags) – the Fwupd.RequestFlags

Adds a specific flag to the request.

New in version 1.8.6.

emit_invalidate()[source]¶: Emits an invalidate signal to signify that the request is no longer valid, and any visible UI components should be hidden.

New in version 1.9.17.

get_created()[source]¶

Returns:: the UNIX time, or 0 if unset
Return type:: int

Gets when the request was created.

New in version 1.6.2.

get_device_id()[source]¶

Returns:: the device_id, or None if unset
Return type:: str

Gets the device_id that created the request.

New in version 1.6.2.

get_flags()[source]¶

Returns:: request flags, or 0 if unset
Return type:: Fwupd.RequestFlags

Gets the request flags.

New in version 1.8.6.

get_id()[source]¶

Returns:: the ID, or None if unset
Return type:: str

Gets the ID.

New in version 1.6.2.

get_image()[source]¶

Returns:: the update image URL, or None if unset
Return type:: str

Gets the update image.

New in version 1.6.2.

get_kind()[source]¶

Returns:: the kind value, e.g. %FWUPD_STATUS_REQUEST_WRITE
Return type:: Fwupd.RequestKind

Returns what the request is currently doing.

New in version 1.6.2.

get_message()[source]¶

Returns:: the update message, or None if unset
Return type:: str

Gets the update message, generating a generic one using the request ID if possible.

New in version 1.6.2.

has_flag(flag)[source]¶

Parameters:: flag (Fwupd.RequestFlags) – the Fwupd.RequestFlags
Returns:: True if the flag is set
Return type:: bool

Finds if the request has a specific flag.

New in version 1.8.6.

remove_flag(flag)[source]¶

Parameters:: flag (Fwupd.RequestFlags) – the Fwupd.RequestFlags

Removes a specific flag from the request.

New in version 1.8.6.

set_created(created)[source]¶

Parameters:: created (int) – the UNIX time

Sets when the request was created.

New in version 1.6.2.

set_device_id(device_id)[source]¶

Parameters:: device_id (str or None) – the device_id, e.g. colorhug

Sets the device_id that created the request.

New in version 1.6.2.

set_flags(flags)[source]¶

Parameters:: flags (Fwupd.RequestFlags) – request flags, e.g. Fwupd.RequestFlags.NONE

Sets the request flags.

New in version 1.8.6.

set_id(id)[source]¶

Parameters:: id (str or None) – the request ID, e.g. USB:foo

Sets the ID.

New in version 1.6.2.

set_image(image)[source]¶

Parameters:: image (str or None) – the update image URL

Sets the update image.

New in version 1.6.2.

set_kind(kind)[source]¶

Parameters:: kind (Fwupd.RequestKind) – the kind value, e.g. %FWUPD_STATUS_REQUEST_WRITE

Sets what the request is currently doing.

New in version 1.6.2.

set_message(message)[source]¶

Parameters:: message (str or None) – the update message string

Sets the update message.

New in version 1.6.2.

do_invalidate() virtual¶

Signal Details¶

Fwupd.Request.signals.invalidate(request)¶

Signal Name:: invalidate
Flags:: RUN_LAST
Parameters:: request (Fwupd.Request) – The object which received the signal

The ::invalidate signal is emitted when the request is no longer valid, and any visible UI components should be hidden.

New in version 1.9.17.

Property Details¶

Fwupd.Request.props.device_id¶

Name:: device-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The device ID for the request.

New in version 1.8.2.

Fwupd.Request.props.flags¶

Name:: flags
Type:: int
Default Value:: 18446744073709551615
Flags:: READABLE, WRITABLE

The flags for the request.

New in version 1.8.6.

Fwupd.Request.props.id¶

Name:: id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The request identifier.

New in version 1.6.2.

Fwupd.Request.props.image¶

Name:: image
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The image link for the request.

New in version 1.6.2.

Fwupd.Request.props.kind¶

Name:: kind
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The kind of the request.

New in version 1.6.2.

Fwupd.Request.props.message¶

Name:: message
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The message text in the request.

New in version 1.6.2.