module:model/RecipientOption

module:model/RecipientOption

new module:model/RecipientOption()

Source:

Constructs a new RecipientOption.
Describes a recipient who is a member of a conditional group.

Members

(inner) email :String

Source:
Type:
  • String

(inner) name :String

Source:
Type:
  • String

(inner) recipientLabel :String

Source:
Type:
  • String

(inner) roleName :String

Source:

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

Type:
  • String

(inner) signingGroupId :String

Source:

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

Type:
  • String

Methods

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

Source:

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

Optional instance to populate.

Returns:

The populated RecipientOption instance.

Type
module:model/RecipientOption