Class InlineObject

InlineObject

Inheritance

System.Object

InlineObject

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class InlineObject : object

Constructors

| Improve this Doc View Source

InlineObject()

Initializes a new instance of the InlineObject class.

Declaration

protected InlineObject()

| Improve this Doc View Source

InlineObject(List<Stream>, String, String, List<DocumentSigner>, List<DocumentCC>, List<FormField>, Boolean, Boolean, Nullable<Int32>, Boolean, Nullable<DateTime>, Nullable<ReminderType>, Boolean)

Initializes a new instance of the InlineObject class.

Declaration

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 = null, bool enableDigitalSignature = null, int? expiryDays = null, bool enablePrintAndSign = null, DateTime? reminderDate = null, ReminderType? reminderFrequency = null, bool disableEmails = null)

Parameters

Type	Name	Description
List<Stream>	files	Gets or sets list of files. (required).
System.String	title	Gets or sets document title. (required).
System.String	message	Gets or sets document message or description..
List<DocumentSigner>	signers	Gets or sets document Signers. (required).
List<DocumentCC>	cC	Gets or sets document CC..
List<FormField>	formFields	Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc. (required).
System.Boolean	enableSigningOrder	Gets or sets a value indicating whether to enable signing order for the document signer..
System.Boolean	enableDigitalSignature	Gets or sets a value indicating whether digital signature is required..
System.Nullable<System.Int32>	expiryDays	Gets or sets the expiry days..
System.Boolean	enablePrintAndSign	Gets or sets a value indicating whether to enable Print and Sign mode..
System.Nullable<DateTime>	reminderDate	Gets or sets the reminder date..
System.Nullable<ReminderType>	reminderFrequency	reminderFrequency.
System.Boolean	disableEmails	Gets or sets a value indicating whether to enable embedded signing. When EmbeddedSigning is enabled, Reminder is automatically ignored..

Properties

| Improve this Doc View Source

CC

Gets or sets document CC.

Declaration

public List<DocumentCC> CC { get; set; }

Property Value

Type	Description
List<DocumentCC>	Gets or sets document CC.

| Improve this Doc View Source

DisableEmails

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

Declaration

public bool DisableEmails { get; set; }

Property Value

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

| Improve this Doc View Source

EnableDigitalSignature

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

Declaration

public bool EnableDigitalSignature { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value indicating whether digital signature is required.

| Improve this Doc View Source

EnablePrintAndSign

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

Declaration

public bool EnablePrintAndSign { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value indicating whether to enable Print and Sign mode.

| Improve this Doc View Source

EnableSigningOrder

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

Declaration

public bool EnableSigningOrder { get; set; }

Property Value

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

| Improve this Doc View Source

ExpiryDays

Gets or sets the expiry days.

Declaration

public int? ExpiryDays { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Gets or sets the expiry days.

| Improve this Doc View Source

Files

Gets or sets list of files.

Declaration

public List<Stream> Files { get; set; }

Property Value

Type	Description
List<Stream>	Gets or sets list of files.

| Improve this Doc View Source

FormFields

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

Declaration

public List<FormField> FormFields { get; set; }

Property Value

Type	Description
List<FormField>	Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc.

| Improve this Doc View Source

Message

Gets or sets document message or description.

Declaration

public string Message { get; set; }

Property Value

Type	Description
System.String	Gets or sets document message or description.

| Improve this Doc View Source

ReminderDate

Gets or sets the reminder date.

Declaration

public DateTime? ReminderDate { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>	Gets or sets the reminder date.

| Improve this Doc View Source

ReminderFrequency

Gets or Sets ReminderFrequency

Declaration

public ReminderType? ReminderFrequency { get; set; }

Property Value

Type	Description
System.Nullable<ReminderType>

| Improve this Doc View Source

Signers

Gets or sets document Signers.

Declaration

public List<DocumentSigner> Signers { get; set; }

Property Value

Type	Description
List<DocumentSigner>	Gets or sets document Signers.

| Improve this Doc View Source

Title

Gets or sets document title.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	Gets or sets document title.

Methods

| Improve this Doc View Source

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object