Class DocumentInfo

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

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

[DataContract]
public class DocumentInfo

Inheritance

object

DocumentInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentInfo()

Initializes a new instance of the DocumentInfo class.

public DocumentInfo()

DocumentInfo(Languages, string, string)

Initializes a new instance of the DocumentInfo class.

[Obsolete("The language-based constructor is deprecated. Please use the new constructor: DocumentInfo(string documentTitle, string documentDescription = default)")]
public DocumentInfo(Languages language = Languages.None, string title = null, string description = null)

Parameters

language Languages

Gets or sets the language.

title string

Gets or sets the title.

description string

Gets or sets the descriptiondescription.

DocumentInfo(string, string, Locales)

Initializes a new instance of the DocumentInfo class.

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

Parameters

documentTitle string

Gets or sets the documentTitle.(required).

documentDescription string

Gets or sets the documentDescription.

locale Locales

Gets or sets the locale.

Properties

Description

Gets or sets the description.

[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }

Property Value

string

Gets or sets the Description.

Language

Gets or sets the language of the document.

[DataMember(Name = "language", EmitDefaultValue = true)]
[Obsolete("Language is deprecated, please use Locale instead.")]
public Languages Language { get; set; }

Property Value

Languages

Locale

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

[DataMember(Name = "locale", EmitDefaultValue = true)]
public Locales Locale { get; set; }

Property Value

Locales

Title

Gets or sets the title.

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

Property Value

string

Gets or sets the Title.

Methods

ToJson()

Returns the JSON string presentation of the object.

public virtual string ToJson()

Returns

string

JSON string presentation of the object.