Object specifying the format of the string provided to a recipient in order to access an envelope. More...

Inheritance diagram for DocuSign.eSign.Model.AccessCodeFormat:

Public Member Functions
	AccessCodeFormat (string FormatRequired=default(string), SettingsMetadata FormatRequiredMetadata=default(SettingsMetadata), string LetterRequired=default(string), SettingsMetadata LetterRequiredMetadata=default(SettingsMetadata), string MinimumLength=default(string), SettingsMetadata MinimumLengthMetadata=default(SettingsMetadata), string NumberRequired=default(string), SettingsMetadata NumberRequiredMetadata=default(SettingsMetadata), string SpecialCharacterRequired=default(string), SettingsMetadata SpecialCharacterRequiredMetadata=default(SettingsMetadata))
	Initializes a new instance of the AccessCodeFormat 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 (AccessCodeFormat other)
	Returns true if AccessCodeFormat instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	FormatRequired `[get, set]`
	Gets or Sets FormatRequired More...

SettingsMetadata	FormatRequiredMetadata `[get, set]`
	Metadata indicating whether the `formatRequired` property is editable. More...

string	LetterRequired `[get, set]`
	Gets or Sets LetterRequired More...

SettingsMetadata	LetterRequiredMetadata `[get, set]`
	Metadata indicating whether the `letterRequired` property is editable. More...

string	MinimumLength `[get, set]`
	Gets or Sets MinimumLength More...

SettingsMetadata	MinimumLengthMetadata `[get, set]`
	Metadata indicating whether the `minimumLength` property is editable. More...

string	NumberRequired `[get, set]`
	Gets or Sets NumberRequired More...

SettingsMetadata	NumberRequiredMetadata `[get, set]`
	Metadata indicating whether the `numberRequired` property is editable. More...

string	SpecialCharacterRequired `[get, set]`
	Gets or Sets SpecialCharacterRequired More...

SettingsMetadata	SpecialCharacterRequiredMetadata `[get, set]`
	Metadata indicating whether the `specialCharacterRequired` property is editable. More...

Detailed Description

Object specifying the format of the string provided to a recipient in order to access an envelope.

Constructor & Destructor Documentation

◆ AccessCodeFormat()

DocuSign.eSign.Model.AccessCodeFormat.AccessCodeFormat	(	string	FormatRequired = `default(string)`,
		SettingsMetadata	FormatRequiredMetadata = `default(SettingsMetadata)`,
		string	LetterRequired = `default(string)`,
		SettingsMetadata	LetterRequiredMetadata = `default(SettingsMetadata)`,
		string	MinimumLength = `default(string)`,
		SettingsMetadata	MinimumLengthMetadata = `default(SettingsMetadata)`,
		string	NumberRequired = `default(string)`,
		SettingsMetadata	NumberRequiredMetadata = `default(SettingsMetadata)`,
		string	SpecialCharacterRequired = `default(string)`,
		SettingsMetadata	SpecialCharacterRequiredMetadata = `default(SettingsMetadata)`
	)

inline

Initializes a new instance of the AccessCodeFormat class.

Parameters

FormatRequired	FormatRequired.
FormatRequiredMetadata	Metadata indicating whether the `formatRequired` property is editable..
LetterRequired	LetterRequired.
LetterRequiredMetadata	Metadata indicating whether the `letterRequired` property is editable..
MinimumLength	MinimumLength.
MinimumLengthMetadata	Metadata indicating whether the `minimumLength` property is editable..
NumberRequired	NumberRequired.
NumberRequiredMetadata	Metadata indicating whether the `numberRequired` property is editable..
SpecialCharacterRequired	SpecialCharacterRequired.
SpecialCharacterRequiredMetadata	Metadata indicating whether the `specialCharacterRequired` property is editable..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.AccessCodeFormat.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.AccessCodeFormat.Equals ( AccessCodeFormat other )

inline

Returns true if AccessCodeFormat instances are equal

Parameters

other Instance of AccessCodeFormat to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ FormatRequired

string DocuSign.eSign.Model.AccessCodeFormat.FormatRequired

getset

Gets or Sets FormatRequired

◆ FormatRequiredMetadata

SettingsMetadata DocuSign.eSign.Model.AccessCodeFormat.FormatRequiredMetadata

getset

Metadata indicating whether the `formatRequired` property is editable.

◆ LetterRequired

string DocuSign.eSign.Model.AccessCodeFormat.LetterRequired

getset

Gets or Sets LetterRequired

◆ LetterRequiredMetadata

SettingsMetadata DocuSign.eSign.Model.AccessCodeFormat.LetterRequiredMetadata

getset

Metadata indicating whether the `letterRequired` property is editable.

◆ MinimumLength

string DocuSign.eSign.Model.AccessCodeFormat.MinimumLength

getset

Gets or Sets MinimumLength

◆ MinimumLengthMetadata

SettingsMetadata DocuSign.eSign.Model.AccessCodeFormat.MinimumLengthMetadata

getset

Metadata indicating whether the `minimumLength` property is editable.

◆ NumberRequired

string DocuSign.eSign.Model.AccessCodeFormat.NumberRequired

getset

Gets or Sets NumberRequired

◆ NumberRequiredMetadata

SettingsMetadata DocuSign.eSign.Model.AccessCodeFormat.NumberRequiredMetadata

getset

Metadata indicating whether the `numberRequired` property is editable.

◆ SpecialCharacterRequired

string DocuSign.eSign.Model.AccessCodeFormat.SpecialCharacterRequired

getset

Gets or Sets SpecialCharacterRequired

◆ SpecialCharacterRequiredMetadata

SettingsMetadata DocuSign.eSign.Model.AccessCodeFormat.SpecialCharacterRequiredMetadata

getset

Metadata indicating whether the `specialCharacterRequired` property is editable.

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

sdk/src/DocuSign.eSign/Model/AccessCodeFormat.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AccessCodeFormat()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ FormatRequired

◆ FormatRequiredMetadata

◆ LetterRequired

◆ LetterRequiredMetadata

◆ MinimumLength

◆ MinimumLengthMetadata

◆ NumberRequired

◆ NumberRequiredMetadata

◆ SpecialCharacterRequired

◆ SpecialCharacterRequiredMetadata