Class Document
The documents properties include users who acted on it, activity date, cc details, created date, and so on.
Namespace: BoldSign.Model
Assembly: BoldSign.Api.dll
Syntax
public class Document : object
Constructors
| Improve this Doc View SourceDocument(String, DocumentSenderDetail, List<DocumentCcDetails>, Int64, Nullable<Int64>, String, String, Nullable<DocumentStatus>, List<DocumentSignerDetails>, Nullable<Int64>, Boolean, List<String>, Nullable<Int64>, String)
Initializes a new instance of the Document class.
Declaration
public Document(string documentId = null, DocumentSenderDetail senderDetail = null, List<DocumentCcDetails> ccDetails = null, long createdDate = null, long? activityDate = null, string activityBy = null, string messageTitle = null, DocumentStatus? status = null, List<DocumentSignerDetails> signerDetails = null, long? expiryDate = null, bool enableSigningOrder = null, List<string> labels = null, long? cursor = null, string brandId = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Gets or sets the document id.. |
DocumentSenderDetail | senderDetail | senderDetail. |
List<DocumentCcDetails> | ccDetails | Gets or sets the CC details.. |
System.Int64 | createdDate | Gets or sets the createdDate.. |
System.Nullable<System.Int64> | activityDate | Gets or sets the activityDate.. |
System.String | activityBy | Gets or sets the activityBy.. |
System.String | messageTitle | Gets or sets the messageTitle.. |
System.Nullable<DocumentStatus> | status | status. |
List<DocumentSignerDetails> | signerDetails | Gets or sets the signerDetails.. |
System.Nullable<System.Int64> | expiryDate | Gets or sets the expiryDate.. |
System.Boolean | enableSigningOrder | Gets or sets a value indicating whether to enable signing order.. |
List<System.String> | labels | Gets or sets the labels. |
System.Nullable<System.Int64> | cursor | Gets or sets the cursor. |
System.String | brandId | Gets or sets the brandId. |
Properties
| Improve this Doc View SourceActivityBy
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. |
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. |
BrandId
Gets or sets a brandId.
Declaration
public string BrandId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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. |
CreatedDate
Gets or sets the created date.
Declaration
public long CreatedDate { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 | Gets or sets the createdDate. |
Cursor
Gets or sets the cursor.
Declaration
public long? Cursor { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
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. |
EnableSigningOrder
Gets or sets a value indicating whether signing order is enabled.
Declaration
public bool EnableSigningOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Gets or sets a value indicating whether to enable signing order. |
ExpiryDate
Gets or sets the expiry date.
Declaration
public long? ExpiryDate { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> | Gets or sets the expiryDate. |
Labels
Gets or sets a labels.
Declaration
public List<string> Labels { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
MessageTitle
Gets or sets the message title.
Declaration
public string MessageTitle { get; set; }
Property Value
Type | Description |
---|---|
System.String | Gets or sets the messageTitle. |
SenderDetail
Gets or sets sender detail of a document.
Declaration
public DocumentSenderDetail SenderDetail { get; set; }
Property Value
Type | Description |
---|---|
DocumentSenderDetail |
SignerDetails
Gets or sets the signer details for a document.
Declaration
public List<DocumentSignerDetails> SignerDetails { get; set; }
Property Value
Type | Description |
---|---|
List<DocumentSignerDetails> | Gets or sets the signerDetails. |
Status
Gets or Sets document status.
Declaration
public DocumentStatus? Status { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DocumentStatus> |
Methods
| Improve this Doc View SourceToJson()
Returns the JSON string presentation of the object
Declaration
public virtual string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |