module:model/DocumentVisibility

module:model/DocumentVisibility

new module:model/DocumentVisibility()

Source:

Constructs a new DocumentVisibility.
This object configures a recipient's read/write access to a document.

Members

(inner) documentId :String

Source:

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Type:
  • String

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(inner) recipientId :String

Source:

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Type:
  • String

(inner) rights :String

Source:
Type:
  • String

(inner) visible :String

Source:
Type:
  • String

Methods

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

Source:

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

Optional instance to populate.

Returns:

The populated DocumentVisibility instance.

Type
module:model/DocumentVisibility