Table of Contents

Class EmbeddedCloneDocumentRequest

Namespace
BoldSign.Api.Model
Assembly
BoldSign.Api.dll

Embedded clone document request.

[DataContract(Name = "EmbeddedCloneDocumentRequest")]
public class EmbeddedCloneDocumentRequest
Inheritance
EmbeddedCloneDocumentRequest
Inherited Members

Properties

DocumentId

Gets or sets the document id.

[JsonProperty("documentId")]
public string DocumentId { get; set; }

Property Value

string

IncludeFormFieldValues

Gets or sets a value indicating whether to show With FormField Values.

[JsonProperty("includeFormFieldValues")]
[Display(Description = "Show the document With FormField Values.")]
public bool IncludeFormFieldValues { get; set; }

Property Value

bool

LinkValidTill

Gets or sets a expiry date for create link. Maximum valid till is 180 days. Default is 30 days.

[JsonProperty("linkValidTill")]
[Display(Description = "Set the validity of the generated URL and its maximum validity is 180 days.")]
[DataType(DataType.DateTime)]
public DateTime? LinkValidTill { get; set; }

Property Value

DateTime?

Locale

Gets or sets the locale.

[JsonProperty("locale")]
[Display(Description = "Contents exists in the New Page, Prepare Page and Preview Page will be displayed in the language selected.")]
public Locales Locale { get; set; }

Property Value

Locales

OnBehalfOf

Gets or sets the on behalf of email address.

[JsonProperty("onBehalfOf")]
[Display(Description = "The property is used to get or set the on behalf of sender email address.")]
public string OnBehalfOf { get; set; }

Property Value

string

RedirectUrl

Gets or sets the RedirectUrl.

[JsonProperty("redirectUrl")]
[Display(Description = "This property is used to redirect to the URL after the embed cloned document process is completed.")]
public Uri RedirectUrl { get; set; }

Property Value

Uri

ShowNavigationButtons

Gets or sets a value indicating whether to show navigation buttons.

[JsonProperty("showNavigationButtons")]
[Display(Description = "Show the navigation buttons in both filling and prepare page.")]
public bool ShowNavigationButtons { get; set; }

Property Value

bool

ShowPreviewButton

Gets or sets a value indicating whether to show preview button.

[JsonProperty("showPreviewButton")]
[Display(Description = "Show the preview of the document to review.")]
public bool ShowPreviewButton { get; set; }

Property Value

bool

ShowSaveButton

Gets or sets a value indicating whether to show save button.

[JsonProperty("showSaveButton")]
[Display(Description = "Show the save option in both filling and prepare page, to save the progress of the document.")]
public bool ShowSaveButton { get; set; }

Property Value

bool

ShowSendButton

Gets or sets a value indicating whether to show send button.

[JsonProperty("showSendButton")]
[Display(Description = "Show the send button in prepare page to send the document.")]
public bool ShowSendButton { get; set; }

Property Value

bool

ShowToolbar

Gets or sets a value indicating whether to show tool bar.

[JsonProperty("showToolbar")]
[Display(Description = "Toggle the visibility of the tool bar with options in both the filling and prepare pages.")]
public bool ShowToolbar { get; set; }

Property Value

bool

ShowTooltip

Gets or sets a value indicating whether to show the tooltip.

[JsonProperty("showTooltip")]
[Display(Description = "Show the tooltip in the prepare page.")]
public bool ShowTooltip { get; set; }

Property Value

bool

ViewOption

Gets or sets the create view option.

[JsonProperty("viewOption")]
[Display(Description = "Setting enum to FillingPage will make the user start with document uploading and signers filling page. Setting enum to PreparePage will make the user start with preparing or configuring fields page of the document.")]
public PageViewOption ViewOption { get; set; }

Property Value

PageViewOption