C# Class Rock.Security.DigitalSignatureComponent

The base class for all digital signature methods

Inheritance: Rock.Extension.Component

Public Methods

Method	Description
CancelDocument ( SignatureDocument document, List &errors ) : bool	Cancels the document.
CreateDocument ( SignatureDocumentTemplate documentType, Person appliesTo, Person assignedTo, string documentName, List &errors, bool sendInvite ) : string	Abstract method for requesting a document be sent to recipient for signature
GetDocument ( SignatureDocument document, string folderPath, List &errors ) : string	Gets the document.
GetInviteLink ( SignatureDocument document, Person recipient, List &errors ) : string	Gets the invite link.
GetInviteLink ( string documentId, List &errors ) : string	Gets the invite link.
GetTemplates ( List &errors ) : string>.Dictionary	Gets the templates.
ResendDocument ( SignatureDocument document, List &errors ) : bool	Resends the document.
UpdateDocumentStatus ( SignatureDocument document, List &errors ) : bool	Updates the document status

Cancels the document.

public abstract CancelDocument ( SignatureDocument document, List &errors ) : bool
document	SignatureDocument	The document.
errors	List	The errors.
return	bool

Abstract method for requesting a document be sent to recipient for signature

public abstract CreateDocument ( SignatureDocumentTemplate documentType, Person appliesTo, Person assignedTo, string documentName, List &errors, bool sendInvite ) : string
documentType	SignatureDocumentTemplate	Type of the document.
appliesTo	Person	The applies to.
assignedTo	Person	The assigned to.
documentName	string	Name of the document.
errors	List	The errors.
sendInvite	bool	if set to true [send invite].
return	string

Gets the document.

public abstract GetDocument ( SignatureDocument document, string folderPath, List &errors ) : string
document	SignatureDocument	The document.
folderPath	string	The folder path.
errors	List	The errors.
return	string

Gets the invite link.

public abstract GetInviteLink ( SignatureDocument document, Person recipient, List &errors ) : string
document	SignatureDocument	The document.
recipient	Person	The recipient.
errors	List	The errors.
return	string

Gets the invite link.

public abstract GetInviteLink ( string documentId, List &errors ) : string
documentId	string	The document identifier.
errors	List	The errors.
return	string

Gets the templates.

public abstract GetTemplates ( List &errors ) : string>.Dictionary
errors	List	The errors.
return	string>.Dictionary

Resends the document.

public abstract ResendDocument ( SignatureDocument document, List &errors ) : bool
document	SignatureDocument	The document.
errors	List	The errors.
return	bool

Updates the document status

public abstract UpdateDocumentStatus ( SignatureDocument document, List &errors ) : bool
document	SignatureDocument	The document.
errors	List	The errors.
return	bool