module:model/Filter

module:model/Filter

new module:model/Filter()

Source:

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

Members

(inner) actionRequired :String

Source:

Access token information.

Type:
  • String

(inner) expires :String

Source:
Type:
  • String

(inner) folderIds :String

Source:
Type:
  • String

(inner) fromDateTime :String

Source:
Type:
  • String

(inner) isTemplate :String

Source:
Type:
  • String

(inner) order :String

Source:
Type:
  • String

(inner) orderBy :String

Source:
Type:
  • String

(inner) searchTarget :String

Source:
Type:
  • String

(inner) searchText :String

Source:
Type:
  • String

(inner) status :String

Source:

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.

Type:
  • String

(inner) toDateTime :String

Source:

Must be set to "bearer".

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/Filter}

Source:

Constructs a Filter from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:model/Filter

Optional instance to populate.

Returns:

The populated Filter instance.

Type
module:model/Filter