DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.Notification Class Reference

A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to true, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to true, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * 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. * expireAfter - An integer that sets the number of days the envelope is active. * 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. More...

Inheritance diagram for DocuSign.eSign.Model.Notification:

Public Member Functions

 Notification (Expirations Expirations=default(Expirations), Reminders Reminders=default(Reminders), string UseAccountDefaults=default(string))
 Initializes a new instance of the Notification 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 (Notification other)
 Returns true if Notification instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

Expirations Expirations [get, set]
 A complex element that specifies the expiration settings for the envelope. More...
 
Reminders Reminders [get, set]
 A complex element that specifies reminder settings for the envelope. More...
 
string UseAccountDefaults [get, set]
 When set to true, the account default notification settings are used for the envelope. More...
 

Detailed Description

A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to true, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to true, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * 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. * expireAfter - An integer that sets the number of days the envelope is active. * 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.

Constructor & Destructor Documentation

◆ Notification()

DocuSign.eSign.Model.Notification.Notification ( Expirations  Expirations = default(Expirations),
Reminders  Reminders = default(Reminders),
string  UseAccountDefaults = default(string) 
)
inline

Initializes a new instance of the Notification class.

Parameters
ExpirationsA complex element that specifies the expiration settings for the envelope..
RemindersA complex element that specifies reminder settings for the envelope..
UseAccountDefaultsWhen set to true, the account default notification settings are used for the envelope..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.Notification.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.Notification.Equals ( Notification  other)
inline

Returns true if Notification instances are equal

Parameters
otherInstance of Notification to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.Notification.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.Notification.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.Notification.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Expirations

Expirations DocuSign.eSign.Model.Notification.Expirations
getset

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

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

◆ Reminders

Reminders DocuSign.eSign.Model.Notification.Reminders
getset

A complex element that specifies reminder settings for the envelope.

A complex element that specifies reminder settings for the envelope.

◆ UseAccountDefaults

string DocuSign.eSign.Model.Notification.UseAccountDefaults
getset

When set to true, the account default notification settings are used for the envelope.

When set to true, the account default notification settings are used for the envelope.


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