Class DocumentInfo

The document information include the language, document title and document description.

Inheritance

System.Object

DocumentInfo

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class DocumentInfo : object

Constructors

DocumentInfo()

Initializes a new instance of the DocumentInfo class.

Declaration

public DocumentInfo()

DocumentInfo(Languages, String, String)

Initializes a new instance of the DocumentInfo class.

Declaration

public DocumentInfo(Languages language = default(Languages), string title = null, string description = null)

Parameters

Type	Name	Description
Languages	language	Gets or sets the language.
System.String	title	Gets or sets the title.
System.String	description	Gets or sets the descriptiondescription.

DocumentInfo(String, String, Locales)

Initializes a new instance of the DocumentInfo class.

Declaration

public DocumentInfo(string documentTitle, string documentDescription = null, Locales locale = Locales.EN)

Parameters

Type	Name	Description
System.String	documentTitle	Gets or sets the documentTitle.(required).
System.String	documentDescription	Gets or sets the documentDescription.
Locales	locale	Gets or sets the locale.

Properties

Description

Gets or sets the description.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	Gets or sets the Description.

Language

Gets or sets the language of the document.

Declaration

public Languages Language { get; set; }

Property Value

Type	Description
Languages

Locale

Gets or sets locale such as EN, FR, ES.

Declaration

public Locales Locale { get; set; }

Property Value

Type	Description
Locales

Title

Gets or sets the title.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	Gets or sets the Title.

Methods

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.