Class PadesSignatureStarter

Utility class to facilitate the startup of a PADeS signature process with Rest PKI

Inheritance
Object
SignatureStarter
PadesSignatureStarter
Inherited Members
Namespace: Lacuna.RestPki.Client
Assembly: Lacuna.RestPki.Client.dll
Syntax
public class PadesSignatureStarter : SignatureStarter

Constructors

PadesSignatureStarter(RestPkiClient)

Declaration
public PadesSignatureStarter(RestPkiClient client)
Parameters
Type Name Description
RestPkiClient client

Properties

BypassMarksIfSigned

Declaration
public bool BypassMarksIfSigned { get; set; }
Property Value
Type Description
Boolean

CertificationLevel

Declaration
public PadesCertificationLevel CertificationLevel { get; set; }
Property Value
Type Description
Lacuna.RestPki.Api.PadesSignature.PadesCertificationLevel

CustomSignatureFieldName

Declaration
public string CustomSignatureFieldName { get; set; }
Property Value
Type Description
String

MeasurementUnits

Declaration
public PadesMeasurementUnits MeasurementUnits { get; set; }
Property Value
Type Description
Lacuna.RestPki.Api.PadesSignature.PadesMeasurementUnits

PageOptimization

Declaration
public PadesPageOptimization PageOptimization { get; set; }
Property Value
Type Description
PadesPageOptimization

PdfMarks

Declaration
public List<PdfMark> PdfMarks { get; set; }
Property Value
Type Description
List<PdfMark>

Reason

Declaration
public string Reason { get; set; }
Property Value
Type Description
String

VisualRepresentation

Declaration
public PadesVisualRepresentation VisualRepresentation { get; set; }
Property Value
Type Description
PadesVisualRepresentation

Methods

SetPdfToSign(FileResult)

Sets the PDf to sign from a file result from a previous call to Rest PKI

Declaration
public void SetPdfToSign(FileResult pdf)
Parameters
Type Name Description
FileResult pdf

SetPdfToSign(Byte[])

Sets the content to sign via a byte array

Declaration
public void SetPdfToSign(byte[] content)
Parameters
Type Name Description
Byte[] content

The byte array representing the content to be signed

SetPdfToSign(Stream)

Sets the content to sign via a stream object

Declaration
public void SetPdfToSign(Stream pdfStream)
Parameters
Type Name Description
Stream pdfStream

The stream representing thye content to be signed

SetPdfToSign(String)

Sets the content to sign via a file path string

Declaration
public void SetPdfToSign(string path)
Parameters
Type Name Description
String path

The path where the file will be found
Exceptions
Type Condition
FileNotFoundException

In case a file cannot be found with the given path string

SetVisualRepresentation(PadesVisualRepresentation)

Indicates that the signature created with this starter will have a visual representation indicated by visualRepresentation

Declaration
public void SetVisualRepresentation(PadesVisualRepresentation visualRepresentation)
Parameters
Type Name Description
PadesVisualRepresentation visualRepresentation

The visual representation that should be added to the result pdf

Start()

Starts the signature without the web pki support

Declaration
public override ClientSideSignatureInstructions Start()
Returns
Type Description
ClientSideSignatureInstructions

The instructions to proceed with the signature
Overrides

StartAsync()

Starts the signature without the web pki support

Declaration
public override Task<ClientSideSignatureInstructions> StartAsync()
Returns
Type Description
Task<ClientSideSignatureInstructions>

The instructions to proceed with the signature
Overrides

StartWithWebPki()

Starts the signature leveraging the presence of the web pki

Declaration
public override string StartWithWebPki()
Returns
Type Description
String

The signature token
Overrides

StartWithWebPkiAsync()

Starts the signature leveraging the presence of the web pki

Declaration
public override Task<string> StartWithWebPkiAsync()
Returns
Type Description
Task<String>

The signature token
Overrides