Class InlineObject

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

InlineObject

[DataContract]
public class InlineObject

Inheritance

object

InlineObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

InlineObject()

Initializes a new instance of the InlineObject class.

[JsonConstructor]
protected InlineObject()

InlineObject(List<Stream>, string, string, List<DocumentSigner>, List<DocumentCC>, List<FormField>, bool, bool, int?, bool, DateTime?, ReminderType?, bool)

Initializes a new instance of the InlineObject class.

public InlineObject(List<Stream> files = null, string title = null, string message = null, List<DocumentSigner> signers = null, List<DocumentCC> cC = null, List<FormField> formFields = null, bool enableSigningOrder = false, bool enableDigitalSignature = false, int? expiryDays = null, bool enablePrintAndSign = false, DateTime? reminderDate = null, ReminderType? reminderFrequency = null, bool disableEmails = false)

Parameters

files List<Stream>

Gets or sets list of files. (required).

title string

Gets or sets document title. (required).

message string

Gets or sets document message or description..

signers List<DocumentSigner>

Gets or sets document Signers. (required).

cC List<DocumentCC>

Gets or sets document CC..

formFields List<FormField>

Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc. (required).

enableSigningOrder bool

Gets or sets a value indicating whether to enable signing order for the document signer..

enableDigitalSignature bool

Gets or sets a value indicating whether digital signature is required..

expiryDays int?

Gets or sets the expiry days..

enablePrintAndSign bool

Gets or sets a value indicating whether to enable Print and Sign mode..

reminderDate DateTime?

Gets or sets the reminder date..

reminderFrequency ReminderType?

reminderFrequency.

disableEmails bool

Gets or sets a value indicating whether to enable embedded signing. When EmbeddedSigning is enabled, Reminder is automatically ignored..

Properties

CC

Gets or sets document CC.

[DataMember(Name = "CC", EmitDefaultValue = true)]
public List<DocumentCC> CC { get; set; }

Property Value

List<DocumentCC>

Gets or sets document CC.

DisableEmails

Gets or sets a value indicating whether to enable embedded signing. When EmbeddedSigning is enabled, Reminder is automatically ignored.

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

Property Value

bool

Gets or sets a value indicating whether to enable embedded signing. When EmbeddedSigning is enabled, Reminder is automatically ignored.

EnableDigitalSignature

Gets or sets a value indicating whether digital signature is required.

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

Property Value

bool

Gets or sets a value indicating whether digital signature is required.

EnablePrintAndSign

Gets or sets a value indicating whether to enable Print and Sign mode.

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

Property Value

bool

Gets or sets a value indicating whether to enable Print and Sign mode.

EnableSigningOrder

Gets or sets a value indicating whether to enable signing order for the document signer.

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

Property Value

bool

Gets or sets a value indicating whether to enable signing order for the document signer.

ExpiryDays

Gets or sets the expiry days.

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

Property Value

int?

Gets or sets the expiry days.

Files

Gets or sets list of files.

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

Property Value

List<Stream>

Gets or sets list of files.

FormFields

Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc.

[DataMember(Name = "FormFields", EmitDefaultValue = true)]
public List<FormField> FormFields { get; set; }

Property Value

List<FormField>

Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc.

Message

Gets or sets document message or description.

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

Property Value

string

Gets or sets document message or description.

ReminderDate

Gets or sets the reminder date.

[DataMember(Name = "ReminderDate", EmitDefaultValue = true)]
public DateTime? ReminderDate { get; set; }

Property Value

DateTime?

Gets or sets the reminder date.

ReminderFrequency

Gets or Sets ReminderFrequency

[DataMember(Name = "ReminderFrequency", EmitDefaultValue = false)]
public ReminderType? ReminderFrequency { get; set; }

Property Value

ReminderType?

Signers

Gets or sets document Signers.

[DataMember(Name = "Signers", EmitDefaultValue = true)]
public List<DocumentSigner> Signers { get; set; }

Property Value

List<DocumentSigner>

Gets or sets document Signers.

Title

Gets or sets document title.

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

Property Value

string

Gets or sets document title.

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object