module:model/UserProfile

module:model/UserProfile

new module:model/UserProfile()

Source:

Constructs a new UserProfile.

Members

(inner) address :module:model/AddressInformation

Source:

The user's address.

Type:

(inner) authenticationMethods :Array.<module:model/AuthenticationMethod>

Source:

These properties cannot be modified in the PUT. Indicates the authentication methods used by the user.

Type:

(inner) companyName :String

Source:

The name of the user's Company.

Type:
  • String

(inner) displayOrganizationInfo :String

Source:

When set to true, the user's company and title information are shown on the ID card.

Type:
  • String

(inner) displayPersonalInfo :String

Source:

When set to true, the user's Address and Phone number are shown on the ID card.

Type:
  • String

(inner) displayProfile :String

Source:

When set to true, the user's ID card can be viewed from signed documents and envelope history.

Type:
  • String

(inner) displayUsageHistory :String

Source:

When set to true, the user's usage information is shown on the ID card.

Type:
  • String

(inner) profileImageUri :String

Source:
Type:
  • String

(inner) title :String

Source:
Type:
  • String

(inner) usageHistory :module:model/UsageHistory

Source:

A complex element consisting of: - lastSentDateTime: The date and time the user last sent an envelope. - lastSignedDateTime: The date and time the user last signed an envelope. - sentCount: The number of envelopes the user has sent. - signedCount: The number of envelopes the user has signed.

Type:

(inner) userDetails :module:model/UserInformation

Source:
Type:

(inner) userProfileLastModifiedDate :String

Source:
Type:
  • String

Methods

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

Source:

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

Optional instance to populate.

Returns:

The populated UserProfile instance.

Type
module:model/UserProfile