FPrint.Print¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`deserialize` (data)
class	`new` (device)
	`compatible` (device)
	`equal` (other)
	`get_description` ()
	`get_device_id` ()
	`get_device_stored` ()
	`get_driver` ()
	`get_enroll_date` ()
	`get_finger` ()
	`get_image` ()
	`get_username` ()
	`serialize` ()
	`set_description` (description)
	`set_enroll_date` (enroll_date)
	`set_finger` (finger)
	`set_username` (username)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`description`	`str`	r/w	A user defined description for the print
`device-id`	`str`	r/w/co	Unique ID allowing to check if a device is compatible with the print
`device-stored`	`bool`	r/w/co	Whether the print is a handle for data that is stored on the device
`driver`	`str`	r/w/co	The name of the driver that created the print
`enroll-date`	`GLib.Date`	r/w	The date of enrollment
`finger`	`FPrint.Finger`	r/w	The enrolled finger
`fpi-data`	`GLib.Variant`	r/w	The raw data for internal use only
`fpi-prints`	`int`	r/w	Prints for internal use only
`image`	`FPrint.Image`	r	The image that was used for the print, only valid for newly enrolled prints on image based devices
`username`	`str`	r/w	The username that the enrolled print belongs to

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class FPrint.Print(**kwargs)¶

Bases:: GObject.InitiallyUnowned
Abstract:: No
Structure:: FPrint.PrintClass

classmethod deserialize(data)¶

Parameters:: data (bytes) – The binary data
Raises:: GLib.Error
Returns:: A newly created FPrint.Print on success
Return type:: FPrint.Print

Deserialize a print definition from permanent storage.

classmethod new(device)¶

Parameters:: device (FPrint.Device) – A FPrint.Device
Returns:: A newly created FPrint.Print
Return type:: FPrint.Print

Create a new FPrint.Print. This is only useful to prepare an enrollment of a new print using FPrint.Device.enroll(). For this you should first create a new print, fill in the relevant metadata, and then start enrollment.

compatible(device)¶

Parameters:: device (FPrint.Device) – A FPrint.Device
Returns:: True if the print is compatible with the device
Return type:: bool

Tests whether the prints is compatible with the given device.

equal(other)¶

Parameters:: other (FPrint.Print) – Second FPrint.Print
Returns:: True if the prints are equal
Return type:: bool

Tests whether the prints can be considered equal. This only compares the actual information about the print, not the metadata.

get_description()¶

Returns:: The description
Return type:: str or None

Returns the user defined description for the print.

get_device_id()¶

Returns:: The device ID
Return type:: str

Returns the device ID that the print was created for.

get_device_stored()¶

Returns:: Whether the print is stored on the device
Return type:: bool

Whether the print is actually stored on the device and this is just a handle to use that references the device stored data.

get_driver()¶

Returns:: The driver
Return type:: str

Returns the driver that the print was created for.

get_enroll_date()¶

Returns:: The GLib.Date
Return type:: GLib.Date or None

Returns the user defined enroll date for the print.

get_finger()¶

Returns:: The FPrint.Finger
Return type:: FPrint.Finger

Returns the finger that the print was created for.

get_image()¶

Returns:: The FPrint.Image
Return type:: FPrint.Image or None

Returns the image that the print was created from, or None

get_username()¶

Returns:: The username
Return type:: str or None

Returns the user defined username for the print.

serialize()¶

Raises:: GLib.Error
Returns:: Return location for data pointer
Return type:: data: bytes

Serialize a print definition for permanent storage. Note that this is lossy in the sense that e.g. the image data is discarded.

set_description(description)¶

Parameters:: description (str) – The new description

Set the description for the print.

set_enroll_date(enroll_date)¶

Parameters:: enroll_date (GLib.Date) – The new enroll date

Set the enroll date for the print.

set_finger(finger)¶

Parameters:: finger (FPrint.Finger) – The FPrint.Finger

Set the finger that the print is for.

set_username(username)¶

Parameters:: username (str) – The new username

Set the username for the print.

Property Details¶

FPrint.Print.props.description¶

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

A user defined description for the print

FPrint.Print.props.device_id¶

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

Unique ID allowing to check if a device is compatible with the print

FPrint.Print.props.device_stored¶

Name:: device-stored
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Whether the print is a handle for data that is stored on the device

FPrint.Print.props.driver¶

Name:: driver
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the driver that created the print

FPrint.Print.props.enroll_date¶

Name:: enroll-date
Type:: GLib.Date
Default Value:: None
Flags:: READABLE, WRITABLE

The date of enrollment

FPrint.Print.props.finger¶

Name:: finger
Type:: FPrint.Finger
Default Value:: FPrint.Finger.UNKNOWN
Flags:: READABLE, WRITABLE

The enrolled finger

FPrint.Print.props.fpi_data¶

Name:: fpi-data
Type:: GLib.Variant
Default Value:: None
Flags:: READABLE, WRITABLE

The raw data for internal use only

FPrint.Print.props.fpi_prints¶

Name:: fpi-prints
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE

Prints for internal use only

FPrint.Print.props.image¶

Name:: image
Type:: FPrint.Image
Default Value:: None
Flags:: READABLE

The image that was used for the print, only valid for newly enrolled prints on image based devices

FPrint.Print.props.username¶

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

The username that the enrolled print belongs to