Class DocumentProperties

The document properties includes any activity taken on the document, the user who acts on it, date of action, description of document, and so on.

Inheritance

System.Object

DocumentProperties

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class DocumentProperties : object

Constructors

| Improve this Doc View Source

DocumentProperties(String, String, String, DocumentStatus, List<DocumentFiles>, DocumentSenderDetail, List<DocumentSignerDetails>, List<DocumentFormFields>, List<DocumentCcDetails>, ReminderSettings, List<DocumentReassign>, List<AuditTrail>, String, Nullable<Int64>, ActivityAction, Nullable<Int64>, Nullable<Int32>, Nullable<Int64>, Nullable<Boolean>, Nullable<Boolean>, String, String, String, List<String>, String, Boolean, Nullable<Boolean>, Boolean, Boolean, BehalfOf, ExpiryDateType, Nullable<Int64>, DocumentDownloadOption)

Initializes a new instance of the DocumentProperties class.

Declaration

public DocumentProperties(string documentId = null, string messageTitle = null, string documentDescription = null, DocumentStatus status = (DocumentStatus)0, List<DocumentFiles> files = null, DocumentSenderDetail senderDetail = null, List<DocumentSignerDetails> signerDetails = null, List<DocumentFormFields> commonFields = null, List<DocumentCcDetails> ccDetails = null, ReminderSettings reminderSettings = null, List<DocumentReassign> reassign = null, List<AuditTrail> documentHistory = null, string activityBy = null, long? activityDate = null, ActivityAction activityAction = (ActivityAction)0, long? createdDate = null, int? expiryDays = null, long? expiryDate = null, bool? enableSigningOrder = null, bool? isDeleted = null, string revokeMessage = null, string declineMessage = null, string brandId = null, List<string> labels = null, string applicationId = null, bool disableExpiryAlert = null, bool? hideDocumentId = null, bool enablePrintAndSign = null, bool enableReassign = null, BehalfOf behalfOf = null, ExpiryDateType expiryDateType = ExpiryDateType.Days, long? expiryValue = null, DocumentDownloadOption documentDownloadOption = (DocumentDownloadOption)0)

Parameters

Type	Name	Description
System.String	documentId	Gets or sets the document id..
System.String	messageTitle	Gets or sets the messageTitle..
System.String	documentDescription	Gets or Sets document description..
DocumentStatus	status	status.
List<DocumentFiles>	files	Gets or Sets document uploaded file information..
DocumentSenderDetail	senderDetail	senderDetail.
List<DocumentSignerDetails>	signerDetails	Gets or sets the signerDetails..
List<DocumentFormFields>	commonFields	Gets or sets the common fields.
List<DocumentCcDetails>	ccDetails	Gets or sets the CC details..
ReminderSettings	reminderSettings	reminderSettings.
List<DocumentReassign>	reassign	<br>Gets or Sets Reassign message. <br>Available only when at least one of the signer have reassigned to another signer..
List<AuditTrail>	documentHistory	Gets or Sets document history (Audit log)..
System.String	activityBy	Gets or sets the activityBy..
System.Nullable<System.Int64>	activityDate	Gets or sets the activityDate..
ActivityAction	activityAction	activityAction.
System.Nullable<System.Int64>	createdDate	Gets or sets the createdDate..
System.Nullable<System.Int32>	expiryDays	Gets or Sets expiry days of the document..
System.Nullable<System.Int64>	expiryDate	Gets or sets the expiry date of the document..
System.Nullable<System.Boolean>	enableSigningOrder	Gets or sets a value indicating whether to enable signing order..
System.Nullable<System.Boolean>	isDeleted	Gets or sets a value indicating whether the document is deleted..
System.String	revokeMessage	<br>Gets or Sets document revoked message by the sender. <br>Available only when the document is revoked..
System.String	declineMessage	<br>Gets or Sets document declined message by the signer. <br>Available only when any one of the signer have declined the document..
System.String	brandId
List<System.String>	labels
System.String	applicationId
System.Boolean	disableExpiryAlert	Gets or sets a value indicating whether Disableexpiryalert is true or false.
System.Nullable<System.Boolean>	hideDocumentId	Gets or sets a value indicating whether HideDocumentId is true or false.
System.Boolean	enablePrintAndSign	Gets or sets a value indicating whether to Enable Print And Sign.
System.Boolean	enableReassign	Gets or sets a value indicating whether to Enable Reassign.By Default True.
BehalfOf	behalfOf	Gets or sets the behalf details.
ExpiryDateType	expiryDateType	Gets or sets the expiry data type of the document..
System.Nullable<System.Int64>	expiryValue	Gets or sets the expiry value of the document..
DocumentDownloadOption	documentDownloadOption	Gets or sets the document download option.

Properties

| Improve this Doc View Source

ActivityAction

Gets or sets activity action done on the document.

Declaration

public ActivityAction ActivityAction { get; set; }

Property Value

Type	Description
ActivityAction

| Improve this Doc View Source

ActivityBy

Gets or sets the name of the user who performed action.

Declaration

public string ActivityBy { get; set; }

Property Value

Type	Description
System.String	Gets or sets the activityBy.

| Improve this Doc View Source

ActivityDate

Gets or sets the activity date.

Declaration

public long? ActivityDate { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	Gets or sets the activityDate.

| Improve this Doc View Source

ApplicationId

Gets or sets a GUID value that used to identify the application client ID.

Declaration

public string ApplicationId { get; set; }

Property Value

Type	Description
System.String	Gets or sets a GUID value that used to identify the application client ID.

| Improve this Doc View Source

BehalfOf

Gets or sets the behalf detail.

Declaration

public BehalfOf BehalfOf { get; set; }

Property Value

Type	Description
BehalfOf

| Improve this Doc View Source

BrandId

Gets or sets the Brand Id.

Declaration

public string BrandId { get; set; }

Property Value

Type	Description
System.String	Gets or sets the brand id.

| Improve this Doc View Source

CcDetails

Gets or sets the CC details.

Declaration

public List<DocumentCcDetails> CcDetails { get; set; }

Property Value

Type	Description
List<DocumentCcDetails>	Gets or sets the CC details.

| Improve this Doc View Source

CommonFields

Gets or sets the common fields in the document.

Declaration

public List<DocumentFormFields> CommonFields { get; set; }

Property Value

Type	Description
List<DocumentFormFields>	Gets or sets the common fields.

| Improve this Doc View Source

CreatedDate

Gets or sets the created date of a document.

Declaration

public long? CreatedDate { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	Gets or sets the createdDate.

| Improve this Doc View Source

DeclineMessage

Gets or Sets document declined message by the signer. Available only when any one of the signers have declined the document.

Declaration

public string DeclineMessage { get; set; }

Property Value

Type	Description
System.String	<br>Gets or Sets document declined message by the signer. <br>Available only when any one of the signers have declined the document.

| Improve this Doc View Source

DisableEmails

Gets or sets the disableEmails.

Declaration

public bool DisableEmails { get; set; }

Property Value

Type	Description
System.Boolean	When DisableEmails is enabled, Reminder is automatically ignored

| Improve this Doc View Source

DisableExpiryAlert

Gets or sets a value indicating whether Disableexpiryalert is true or false.

Declaration

public bool DisableExpiryAlert { get; set; }

Property Value

Type	Description
System.Boolean	This property will send the expiry alert email before the day of expiry for the pending signers.If the document expires in one day, the email will be sent before 2 hours of the expiry.

| Improve this Doc View Source

DocumentDescription

Gets or sets document description.

Declaration

public string DocumentDescription { get; set; }

Property Value

Type	Description
System.String	Gets or Sets document description.

| Improve this Doc View Source

DocumentDownloadOption

Gets or sets a value indicating whether to enable individual document downloads.

Declaration

public DocumentDownloadOption DocumentDownloadOption { get; set; }

Property Value

Type	Description
DocumentDownloadOption

| Improve this Doc View Source

DocumentHistory

Gets or sets document history (Audit log) for a document.

Declaration

public List<AuditTrail> DocumentHistory { get; set; }

Property Value

Type	Description
List<AuditTrail>	Gets or Sets document history (Audit log).

| Improve this Doc View Source

DocumentId

Gets or sets the document ID.

Declaration

public string DocumentId { get; set; }

Property Value

Type	Description
System.String	Gets or sets the document id.

| Improve this Doc View Source

EnablePrintAndSign

Gets or sets a value indicating whether print and sign is enabled.

Declaration

public bool EnablePrintAndSign { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value of indicating whether to enable print and sign mode.

| Improve this Doc View Source

EnableReassign

Gets or sets a value indicating whether reassign is enabled.

Declaration

public bool EnableReassign { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value of indicating whether to enable reassign mode.By Default True.

| Improve this Doc View Source

EnableSigningOrder

Gets or sets a value indicating whether signing order is enabled.

Declaration

public bool? EnableSigningOrder { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value indicating whether to enable signing order.

| Improve this Doc View Source

ExpiryDate

Gets or sets the expiry date of the document.

Declaration

public long? ExpiryDate { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	Gets or sets the expiry date of the document.

| Improve this Doc View Source

ExpiryDateType

Gets or sets the expiry date type.

Declaration

public ExpiryDateType ExpiryDateType { get; set; }

Property Value

Type	Description
ExpiryDateType

| Improve this Doc View Source

ExpiryDays

Gets or sets expiry days for the document.

Declaration

public int? ExpiryDays { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Gets or Sets expiry days of the document.

| Improve this Doc View Source

ExpiryValue

Gets or sets the expiry value of the document.

Declaration

public long? ExpiryValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	Gets the value of expiry value of the document.

| Improve this Doc View Source

Files

Gets or sets document uploaded file information.

Declaration

public List<DocumentFiles> Files { get; set; }

Property Value

Type	Description
List<DocumentFiles>	Gets or Sets document uploaded file information.

| Improve this Doc View Source

HideDocumentId

Gets or sets a value indicating whether HideDocumentId is true or false.

Declaration

public bool? HideDocumentId { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	When HideDocumentId is enabled , the document Id in the documents is not visible.

| Improve this Doc View Source

IsDeleted

Gets or sets a value indicating whether the document is deleted.

Declaration

public bool? IsDeleted { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value indicating whether the document is deleted.

| Improve this Doc View Source

Labels

Gets or sets the labels.

Declaration

public List<string> Labels { get; set; }

Property Value

Type	Description
List<System.String>	Gets or sets the labels.

| Improve this Doc View Source

MessageTitle

Gets or sets the message title.

Declaration

public string MessageTitle { get; set; }

Property Value

Type	Description
System.String	Gets or sets the messageTitle.

| Improve this Doc View Source

Reassign

Gets or sets reassign message. Available only when at least one of the signers have reassigned to another signer.

Declaration

public List<DocumentReassign> Reassign { get; set; }

Property Value

Type	Description
List<DocumentReassign>	<br>Gets or Sets Reassign message. <br>Available only when at least one of the signers have reassigned to another signer.

| Improve this Doc View Source

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

Declaration

public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

Type	Description
RecipientNotificationSettings	Gets or sets the Recipient Notification Settings of the signer.

| Improve this Doc View Source

ReminderSettings

Gets or sets reminder settings.

Declaration

public ReminderSettings ReminderSettings { get; set; }

Property Value

Type	Description
ReminderSettings

| Improve this Doc View Source

RevokeMessage

Gets or Sets document revoked message by the sender. Available only when the document is revoked.

Declaration

public string RevokeMessage { get; set; }

Property Value

Type	Description
System.String	<br>Gets or Sets document revoked message by the sender. <br>Available only when the document is revoked.

| Improve this Doc View Source

SenderDetail

Gets or sets Sender detail.

Declaration

public DocumentSenderDetail SenderDetail { get; set; }

Property Value

Type	Description
DocumentSenderDetail

| Improve this Doc View Source

SignerDetails

Gets or sets the signer details.

Declaration

public List<DocumentSignerDetails> SignerDetails { get; set; }

Property Value

Type	Description
List<DocumentSignerDetails>	Gets or sets the signerDetails.

| Improve this Doc View Source

Status

Gets or sets the document status

Declaration

public DocumentStatus Status { get; set; }

Property Value

Type	Description
DocumentStatus

Methods

| Improve this Doc View Source

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object