DocuSign.eSign.Model.Filter Class Reference

Use this object to create a filtered view of the items in a folder. More...

Inheritance diagram for DocuSign.eSign.Model.Filter:

Public Member Functions
	Filter (string ActionRequired=default(string), string Expires=default(string), string FolderIds=default(string), string FromDateTime=default(string), string IsTemplate=default(string), string Order=default(string), string OrderBy=default(string), string SearchTarget=default(string), string SearchText=default(string), string Status=default(string), string ToDateTime=default(string))
	Initializes a new instance of the Filter 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 (Filter other)
	Returns true if Filter instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	ActionRequired [get, set]
	Access token information. More...
string	Expires [get, set]
	Gets or Sets Expires More...
string	FolderIds [get, set]
	Gets or Sets FolderIds More...
string	FromDateTime [get, set]
	Gets or Sets FromDateTime More...
string	IsTemplate [get, set]
	Gets or Sets IsTemplate More...
string	Order [get, set]
	Gets or Sets Order More...
string	OrderBy [get, set]
	Gets or Sets OrderBy More...
string	SearchTarget [get, set]
	Gets or Sets SearchTarget More...
string	SearchText [get, set]
	Gets or Sets SearchText More...
string	Status [get, set]
	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. More...
string	ToDateTime [get, set]
	Must be set to "bearer". More...

Detailed Description

Use this object to create a filtered view of the items in a folder.

Constructor & Destructor Documentation

Filter()

DocuSign.eSign.Model.Filter.Filter ( string  ActionRequired = default(string), string  Expires = default(string), string  FolderIds = default(string), string  FromDateTime = default(string), string  IsTemplate = default(string), string  Order = default(string), string  OrderBy = default(string), string  SearchTarget = default(string), string  SearchText = default(string), string  Status = default(string), string  ToDateTime = default(string)  )

inline

Initializes a new instance of the Filter class.

Parameters

ActionRequired	Access token information..
Expires	Expires.
FolderIds	FolderIds.
FromDateTime	FromDateTime.
IsTemplate	IsTemplate.
Order	Order.
OrderBy	OrderBy.
SearchTarget	SearchTarget.
SearchText	SearchText.
Status	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
ToDateTime	Must be set to "bearer"..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if Filter instances are equal

Parameters

other

Instance of Filter to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ActionRequired

string DocuSign.eSign.Model.Filter.ActionRequired

getset

Access token information.

Access token information.

Expires

string DocuSign.eSign.Model.Filter.Expires

getset

Gets or Sets Expires

FolderIds

string DocuSign.eSign.Model.Filter.FolderIds

getset

Gets or Sets FolderIds

FromDateTime

string DocuSign.eSign.Model.Filter.FromDateTime

getset

Gets or Sets FromDateTime

IsTemplate

string DocuSign.eSign.Model.Filter.IsTemplate

getset

Gets or Sets IsTemplate

Order

string DocuSign.eSign.Model.Filter.Order

getset

Gets or Sets Order

OrderBy

string DocuSign.eSign.Model.Filter.OrderBy

getset

Gets or Sets OrderBy

SearchTarget

string DocuSign.eSign.Model.Filter.SearchTarget

getset

Gets or Sets SearchTarget

SearchText

string DocuSign.eSign.Model.Filter.SearchText

getset

Gets or Sets SearchText

Status

string DocuSign.eSign.Model.Filter.Status

getset

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

ToDateTime

string DocuSign.eSign.Model.Filter.ToDateTime

getset

Must be set to "bearer".

Must be set to "bearer".

---

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

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