PapersDocument.DocumentSignatures¶

Implementations:: None

Methods¶

	`can_sign` ()
	`get_available_signing_certificates` ()
	`get_certificate_info` (nick_name)
	`get_signatures` ()
	`has_signatures` ()
	`set_password_callback` (cb, *user_data)
	`sign` (signature, cancellable, callback, *user_data)
	`sign_finish` (result)

Virtual Methods¶

	`do_can_sign` ()
	`do_get_available_signing_certificates` ()
	`do_get_certificate_info` (nick_name)
	`do_get_signatures` ()
	`do_has_signatures` ()
	`do_set_password_callback` (cb, *user_data)
	`do_sign` (signature, cancellable, callback, *user_data)
	`do_sign_finish` (result)

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class PapersDocument.DocumentSignatures¶

Bases:: GObject.GInterface
Structure:: PapersDocument.DocumentSignaturesInterface

can_sign()¶

Returns:: True if signing is supported,otherwise False
Return type:: bool

Checks whether document supports digital signing.

get_available_signing_certificates()¶

Returns:: a list of PapersDocument.CertificateInfo objects or None
Return type:: [PapersDocument.CertificateInfo]

get_certificate_info(nick_name)¶

Parameters:: nick_name (str) – certificate nick name
Returns:: a new PapersDocument.CertificateInfo, or None
Return type:: PapersDocument.CertificateInfo

get_signatures()¶

Returns:: a list of PapersDocument.Signature objects
Return type:: [PapersDocument.Signature]

has_signatures()¶

Returns:: if the document has digital signatures
Return type:: bool

set_password_callback(cb, *user_data)¶

Parameters:

cb (PapersDocument.SignaturePasswordCallback) – (closure user_data) an PapersDocument.SignaturePasswordCallback
user_data (object or None) – data to pass to cb

Popplers crypto backend asks for certificate password before access, so set a helper function to actually allow the user to enter his password.

sign(signature, cancellable, callback, *user_data)¶

Parameters:

signature (PapersDocument.Signature) – a PapersDocument.Signature
cancellable (Gio.Cancellable or None) – a Gio.Cancellable
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback
user_data (object or None) – callback user data

Returns:

True if signing has been started,otherwise False

Return type:

bool

Start the final async process of signing a document using the prepared signature.

sign_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True if signing finish has been started,otherwise False
Return type:: bool

Finish pps_document_signatures_sign operation,

do_can_sign() virtual¶

Returns:: True if signing is supported,otherwise False
Return type:: bool

Checks whether document supports digital signing.

do_get_available_signing_certificates() virtual¶

Returns:: a list of PapersDocument.CertificateInfo objects or None
Return type:: [PapersDocument.CertificateInfo]

do_get_certificate_info(nick_name) virtual¶

Parameters:: nick_name (str) – certificate nick name
Returns:: a new PapersDocument.CertificateInfo, or None
Return type:: PapersDocument.CertificateInfo

do_get_signatures() virtual¶

Returns:: a list of PapersDocument.Signature objects
Return type:: [PapersDocument.Signature]

do_has_signatures() virtual¶

Returns:: if the document has digital signatures
Return type:: bool

do_set_password_callback(cb, *user_data) virtual¶

Parameters:

cb (PapersDocument.SignaturePasswordCallback) – (closure user_data) an PapersDocument.SignaturePasswordCallback
user_data (object or None) – data to pass to cb

Popplers crypto backend asks for certificate password before access, so set a helper function to actually allow the user to enter his password.

do_sign(signature, cancellable, callback, *user_data) virtual¶

Parameters:

signature (PapersDocument.Signature) –
cancellable (Gio.Cancellable or None) –
callback (Gio.AsyncReadyCallback or None) –
user_data (object or None) –

do_sign_finish(result) virtual¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Returns:: True if signing finish has been started,otherwise False
Return type:: bool

Finish pps_document_signatures_sign operation,