Class EmbeddedDocumentEditRequest

Namespace

BoldSign.Api.Model.EditDocument

Assembly

BoldSign.Api.dll

Embedded document edit request.

[DataContract(Name = "EmbeddedDocumentEditRequest")]
public class EmbeddedDocumentEditRequest

Inheritance

object

EmbeddedDocumentEditRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DocumentId

Gets or sets the document id.

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

Property Value

string

LinkValidTill

Gets or sets a expiry date for create link. Maximum valid till is 30 days. Default is 30 minutes. Set the validity of the generated URL and its maximum validity is 30 days.

[JsonProperty("linkValidTill")]
public DateTime? LinkValidTill { get; set; }

Property Value

DateTime?

Locale

Gets or sets the locale. Contents exists in the New Page, Prepare Page and Preview Page will be displayed in the language selected.

[JsonProperty("locale")]
public Locales Locale { get; set; }

Property Value

Locales

OnBehalfOf

Gets or sets the on behalf of email address. The property is used to get or set the on behalf of sender email address.

[JsonProperty("onBehalfOf")]
public string OnBehalfOf { get; set; }

Property Value

string

RedirectUrl

Gets or sets the redirect URL.

[JsonProperty("redirectUrl")]
public Uri RedirectUrl { get; set; }

Property Value

Uri

SendViewOption

Gets or sets the create view option. Setting enum to FillingPage will make the user start with template uploading and signers filling page. Setting enum to PreparePage will make the user start with preparing or configuring fields page of the template.

[JsonProperty("sendViewOption")]
public PageViewOption SendViewOption { get; set; }

Property Value

PageViewOption

ShowNavigationButtons

Gets or sets a value indicating whether to show navigation buttons. Show the navigation buttons in both filling and prepare page.

[JsonProperty("showNavigationButtons")]
public bool ShowNavigationButtons { get; set; }

Property Value

bool

ShowPreviewButton

Gets or sets a value indicating whether to show preview button. Show the preview of the document to review.

[JsonProperty("showPreviewButton")]
public bool ShowPreviewButton { get; set; }

Property Value

bool

ShowSendButton

Gets or sets a value indicating whether to show send button. Show the send button in prepare page to send the document out for signature.

[JsonProperty("showSendButton")]
public bool ShowSendButton { get; set; }

Property Value

bool

ShowToolbar

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

[JsonProperty("showToolbar")]
public bool ShowToolbar { get; set; }

Property Value

bool

Methods

ToJson()

Returns the JSON string presentation of the object.

public virtual string ToJson()

Returns

string

JSON string presentation of the object.