module:model/Folder

module:model/Folder

new module:model/Folder()

Source:

Constructs a new Folder.
This object contains details about a folder.

Members

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(inner) filter :module:model/Filter

Source:

An object used to present a filtered view of the items in a folder.

Type:

(inner) folderId :String

Source:
Type:
  • String

(inner) folderItems :Array.<module:model/FolderItemV2>

Source:

A list of the envelopes in the specified folder or folders.

Type:

(inner) folders :Array.<module:model/Folder>

Source:

A collection of folder objects returned in a response.

Type:

(inner) hasAccess :String

Source:
Type:
  • String

(inner) hasSubFolders :String

Source:
Type:
  • String

(inner) itemCount :String

Source:
Type:
  • String

(inner) name :String

Source:
Type:
  • String

(inner) owner :module:model/UserInfo

Source:

Information about the user who owns the folder.

Type:

(inner) parentFolderId :String

Source:
Type:
  • String

(inner) parentFolderUri :String

Source:
Type:
  • String

(inner) subFolderCount :String

Source:
Type:
  • String

(inner) type :String

Source:
Type:
  • String

(inner) uri :String

Source:
Type:
  • String

Methods

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

Source:

Constructs a Folder 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/Folder

Optional instance to populate.

Returns:

The populated Folder instance.

Type
module:model/Folder