DocuSign.eSign.Model.Expirations Class Reference

A complex element that specifies the expiration settings for the envelope. More...

Inheritance diagram for DocuSign.eSign.Model.Expirations:

Public Member Functions
	Expirations (string ExpireAfter=default(string), string ExpireEnabled=default(string), string ExpireWarn=default(string))
	Initializes a new instance of the Expirations class. More...
override string	ToString ()
	Returns the string presentation of the object More...
string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object obj)
	Returns true if objects are equal More...
bool	Equals (Expirations other)
	Returns true if Expirations instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	ExpireAfter [get, set]
	An integer that sets the number of days the envelope is active. More...
string	ExpireEnabled [get, set]
	When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. More...
string	ExpireWarn [get, set]
	An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. More...

Detailed Description

A complex element that specifies the expiration settings for the envelope.

Constructor & Destructor Documentation

Expirations()

DocuSign.eSign.Model.Expirations.Expirations ( string  ExpireAfter = default(string), string  ExpireEnabled = default(string), string  ExpireWarn = default(string)  )

inline

Initializes a new instance of the Expirations class.

Parameters

ExpireAfter	An integer that sets the number of days the envelope is active..
ExpireEnabled	When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used..
ExpireWarn	An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent..

Member Function Documentation

Equals() [1/2]

override bool DocuSign.eSign.Model.Expirations.Equals ( object  obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns

Boolean

Equals() [2/2]

bool DocuSign.eSign.Model.Expirations.Equals ( Expirations  other )

inline

Returns true if Expirations instances are equal

Parameters

other

Instance of Expirations to be compared

Returns

Boolean

GetHashCode()

override int DocuSign.eSign.Model.Expirations.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

string DocuSign.eSign.Model.Expirations.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string DocuSign.eSign.Model.Expirations.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ExpireAfter

string DocuSign.eSign.Model.Expirations.ExpireAfter

getset

An integer that sets the number of days the envelope is active.

An integer that sets the number of days the envelope is active.

ExpireEnabled

string DocuSign.eSign.Model.Expirations.ExpireEnabled

getset

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

ExpireWarn

string DocuSign.eSign.Model.Expirations.ExpireWarn

getset

An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

---

The documentation for this class was generated from the following file:

• sdk/src/DocuSign.eSign/Model/Expirations.cs