Table of Contents

Class DocumentProperties

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

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.

[DataContract]
public class DocumentProperties
Inheritance
DocumentProperties
Inherited Members

Constructors

DocumentProperties(string, string, string, DocumentStatus, List<DocumentFiles>, DocumentSenderDetail, List<DocumentSignerDetails>, List<DocumentFormFields>, List<DocumentCcDetails>, ReminderSettings, List<DocumentReassign>, List<AuditTrail>, string, long?, ActivityAction, long?, int?, long?, bool?, bool?, string, string, string, List<string>, string, bool, bool?, bool, bool, BehalfOf, ExpiryDateType, long?, DocumentDownloadOption, string)

Initializes a new instance of the DocumentProperties class.

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 = false, bool? hideDocumentId = null, bool enablePrintAndSign = false, bool enableReassign = false, BehalfOf behalfOf = null, ExpiryDateType expiryDateType = ExpiryDateType.Days, long? expiryValue = null, DocumentDownloadOption documentDownloadOption = DocumentDownloadOption.Combined, string downloadFileName = null)

Parameters

documentId string

Gets or sets the document id..

messageTitle string

Gets or sets the messageTitle..

documentDescription string

Gets or Sets document description..

status DocumentStatus

status.

files List<DocumentFiles>

Gets or Sets document uploaded file information..

senderDetail DocumentSenderDetail

senderDetail.

signerDetails List<DocumentSignerDetails>

Gets or sets the signerDetails..

commonFields List<DocumentFormFields>

Gets or sets the common fields.

ccDetails List<DocumentCcDetails>

Gets or sets the CC details..

reminderSettings ReminderSettings

reminderSettings.

reassign List<DocumentReassign>

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

documentHistory List<AuditTrail>

Gets or Sets document history (Audit log)..

activityBy string

Gets or sets the activityBy..

activityDate long?

Gets or sets the activityDate..

activityAction ActivityAction

activityAction.

createdDate long?

Gets or sets the createdDate..

expiryDays int?

Gets or Sets expiry days of the document..

expiryDate long?

Gets or sets the expiry date of the document..

enableSigningOrder bool?

Gets or sets a value indicating whether to enable signing order..

isDeleted bool?

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

revokeMessage string

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

declineMessage string

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

brandId string
labels List<string>
applicationId string
disableExpiryAlert bool

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

hideDocumentId bool?

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

enablePrintAndSign bool

Gets or sets a value indicating whether to Enable Print And Sign.

enableReassign bool

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..

expiryValue long?

Gets or sets the expiry value of the document..

documentDownloadOption DocumentDownloadOption

Gets or sets the document download option.

downloadFileName string

Gets or sets Download FileName.

Properties

ActivityAction

Gets or sets activity action done on the document.

[DataMember(Name = "activityAction", EmitDefaultValue = false)]
public ActivityAction ActivityAction { get; set; }

Property Value

ActivityAction

ActivityBy

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

[DataMember(Name = "activityBy", EmitDefaultValue = false)]
public string ActivityBy { get; set; }

Property Value

string

Gets or sets the activityBy.

ActivityDate

Gets or sets the activity date.

[DataMember(Name = "activityDate", EmitDefaultValue = false)]
public long? ActivityDate { get; set; }

Property Value

long?

Gets or sets the activityDate.

ApplicationId

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

[DataMember(Name = "applicationId", EmitDefaultValue = false)]
public string ApplicationId { get; set; }

Property Value

string

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

BehalfOf

Gets or sets the behalf detail.

[DataMember(Name = "behalfOf", EmitDefaultValue = false)]
public BehalfOf BehalfOf { get; set; }

Property Value

BehalfOf

BrandId

Gets or sets the Brand Id.

[DataMember(Name = "brandId", EmitDefaultValue = false)]
public string BrandId { get; set; }

Property Value

string

Gets or sets the brand id.

CcDetails

Gets or sets the CC details.

[DataMember(Name = "ccDetails", EmitDefaultValue = false)]
public List<DocumentCcDetails> CcDetails { get; set; }

Property Value

List<DocumentCcDetails>

Gets or sets the CC details.

CommonFields

Gets or sets the common fields in the document.

[DataMember(Name = "commonFields", EmitDefaultValue = false)]
public List<DocumentFormFields> CommonFields { get; set; }

Property Value

List<DocumentFormFields>

Gets or sets the common fields.

CreatedDate

Gets or sets the created date of a document.

[DataMember(Name = "createdDate", EmitDefaultValue = false)]
public long? CreatedDate { get; set; }

Property Value

long?

Gets or sets the createdDate.

DeclineMessage

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

[DataMember(Name = "declineMessage", EmitDefaultValue = false)]
public string DeclineMessage { get; set; }

Property Value

string

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

DisableEmails

Gets or sets the disableEmails.

[DataMember(Name = "disableEmails", EmitDefaultValue = false)]
public bool DisableEmails { get; set; }

Property Value

bool

When DisableEmails is enabled, Reminder is automatically ignored

DisableExpiryAlert

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

[DataMember(Name = "disableExpiryAlert ", EmitDefaultValue = false)]
public bool DisableExpiryAlert { get; set; }

Property Value

bool

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.

DocumentDescription

Gets or sets document description.

[DataMember(Name = "documentDescription", EmitDefaultValue = false)]
public string DocumentDescription { get; set; }

Property Value

string

Gets or Sets document description.

DocumentDownloadOption

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

[DataMember(Name = "documentDownloadOption", EmitDefaultValue = true)]
public DocumentDownloadOption DocumentDownloadOption { get; set; }

Property Value

DocumentDownloadOption

DocumentHistory

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

[DataMember(Name = "documentHistory", EmitDefaultValue = false)]
public List<AuditTrail> DocumentHistory { get; set; }

Property Value

List<AuditTrail>

Gets or Sets document history (Audit log).

DocumentId

Gets or sets the document ID.

[DataMember(Name = "documentId", EmitDefaultValue = false)]
public string DocumentId { get; set; }

Property Value

string

Gets or sets the document id.

DownloadFileName

Gets or sets a value indicating whether enable downloadFileName.

[DataMember(Name = "downloadFileName", EmitDefaultValue = false)]
public string DownloadFileName { get; set; }

Property Value

string

EnablePrintAndSign

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

[DataMember(Name = "enablePrintAndSign", EmitDefaultValue = false)]
public bool EnablePrintAndSign { get; set; }

Property Value

bool

Gets or sets a value of indicating whether to enable print and sign mode.

EnableReassign

Gets or sets a value indicating whether reassign is enabled.

[DataMember(Name = "enableReassign", EmitDefaultValue = false)]
public bool EnableReassign { get; set; }

Property Value

bool

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

EnableSigningOrder

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

[DataMember(Name = "enableSigningOrder", EmitDefaultValue = false)]
public bool? EnableSigningOrder { get; set; }

Property Value

bool?

Gets or sets a value indicating whether to enable signing order.

ExpiryDate

Gets or sets the expiry date of the document.

[DataMember(Name = "expiryDate", EmitDefaultValue = false)]
public long? ExpiryDate { get; set; }

Property Value

long?

Gets or sets the expiry date of the document.

ExpiryDateType

Gets or sets the expiry date type.

[DataMember(Name = "expiryDateType", EmitDefaultValue = false)]
public ExpiryDateType ExpiryDateType { get; set; }

Property Value

ExpiryDateType

ExpiryDays

Gets or sets expiry days for the document.

[DataMember(Name = "expiryDays", EmitDefaultValue = false)]
public int? ExpiryDays { get; set; }

Property Value

int?

Gets or Sets expiry days of the document.

ExpiryValue

Gets or sets the expiry value of the document.

[DataMember(Name = "expiryValue", EmitDefaultValue = false)]
public long? ExpiryValue { get; set; }

Property Value

long?

Gets the value of expiry value of the document.

Files

Gets or sets document uploaded file information.

[DataMember(Name = "files", EmitDefaultValue = false)]
public List<DocumentFiles> Files { get; set; }

Property Value

List<DocumentFiles>

Gets or Sets document uploaded file information.

HideDocumentId

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

[DataMember(Name = "hideDocumentId ", EmitDefaultValue = false)]
public bool? HideDocumentId { get; set; }

Property Value

bool?

When HideDocumentId is enabled , the document Id in the documents is not visible.

IsDeleted

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

[DataMember(Name = "isDeleted", EmitDefaultValue = false)]
public bool? IsDeleted { get; set; }

Property Value

bool?

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

Labels

Gets or sets the labels.

[DataMember(Name = "labels", EmitDefaultValue = false)]
public List<string> Labels { get; set; }

Property Value

List<string>

Gets or sets the labels.

MessageTitle

Gets or sets the message title.

[DataMember(Name = "messageTitle", EmitDefaultValue = false)]
public string MessageTitle { get; set; }

Property Value

string

Gets or sets the messageTitle.

Reassign

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

[DataMember(Name = "reassign", EmitDefaultValue = false)]
public List<DocumentReassign> Reassign { get; set; }

Property Value

List<DocumentReassign>

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

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

[DataMember(Name = "recipientNotificationSettings", EmitDefaultValue = false)]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings of the signer.

ReminderSettings

Gets or sets reminder settings.

[DataMember(Name = "reminderSettings", EmitDefaultValue = false)]
public ReminderSettings ReminderSettings { get; set; }

Property Value

ReminderSettings

RevokeMessage

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

[DataMember(Name = "revokeMessage", EmitDefaultValue = false)]
public string RevokeMessage { get; set; }

Property Value

string

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

SenderDetail

Gets or sets Sender detail.

[DataMember(Name = "senderDetail", EmitDefaultValue = false)]
public DocumentSenderDetail SenderDetail { get; set; }

Property Value

DocumentSenderDetail

SignerDetails

Gets or sets the signer details.

[DataMember(Name = "signerDetails", EmitDefaultValue = false)]
public List<DocumentSignerDetails> SignerDetails { get; set; }

Property Value

List<DocumentSignerDetails>

Gets or sets the signerDetails.

Status

Gets or sets the document status

[DataMember(Name = "status", EmitDefaultValue = false)]
public DocumentStatus Status { get; set; }

Property Value

DocumentStatus

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object