Package com.docusign.esign.model

Class UserInformation

  • public class UserInformation
extends Object
    User information..

    • Constructor Detail

      • UserInformation

        public UserInformation()

    • Method Detail

      • activationAccessCode

        public UserInformation activationAccessCode​(String activationAccessCode)
        activationAccessCode.
        Returns:
        UserInformation

      • getActivationAccessCode

        public String getActivationAccessCode()
        The activation code the new user must enter when activating their account..
        Returns:
        activationAccessCode

      • setActivationAccessCode

        public void setActivationAccessCode​(String activationAccessCode)
        setActivationAccessCode.

      • getCompany

        public String getCompany()
        .
        Returns:
        company

      • setCompany

        public void setCompany​(String company)
        setCompany.

      • addConnectConfigurationsItem

        public UserInformation addConnectConfigurationsItem​(ConnectUserObject connectConfigurationsItem)
        addConnectConfigurationsItem.
        Returns:
        UserInformation

      • getConnectConfigurations

        public List<ConnectUserObject> getConnectConfigurations()
        .
        Returns:
        connectConfigurations

      • setConnectConfigurations

        public void setConnectConfigurations​(List<ConnectUserObject> connectConfigurations)
        setConnectConfigurations.

      • countryCode

        public UserInformation countryCode​(String countryCode)
        countryCode.
        Returns:
        UserInformation

      • getCountryCode

        public String getCountryCode()
        .
        Returns:
        countryCode

      • setCountryCode

        public void setCountryCode​(String countryCode)
        setCountryCode.

      • createdDateTime

        public UserInformation createdDateTime​(String createdDateTime)
        createdDateTime.
        Returns:
        UserInformation

      • getCreatedDateTime

        public String getCreatedDateTime()
        Indicates the date and time the item was created..
        Returns:
        createdDateTime

      • setCreatedDateTime

        public void setCreatedDateTime​(String createdDateTime)
        setCreatedDateTime.

      • addCustomSettingsItem

        public UserInformation addCustomSettingsItem​(NameValue customSettingsItem)
        addCustomSettingsItem.
        Returns:
        UserInformation

      • getCustomSettings

        public List<NameValue> getCustomSettings()
        The name/value pair information for the user custom setting..
        Returns:
        customSettings

      • setCustomSettings

        public void setCustomSettings​(List<NameValue> customSettings)
        setCustomSettings.

      • defaultAccountId

        public UserInformation defaultAccountId​(String defaultAccountId)
        defaultAccountId.
        Returns:
        UserInformation

      • getDefaultAccountId

        public String getDefaultAccountId()
        .
        Returns:
        defaultAccountId

      • setDefaultAccountId

        public void setDefaultAccountId​(String defaultAccountId)
        setDefaultAccountId.

      • getEmail

        public String getEmail()
        .
        Returns:
        email

      • setEmail

        public void setEmail​(String email)
        setEmail.

      • enableConnectForUser

        public UserInformation enableConnectForUser​(String enableConnectForUser)
        enableConnectForUser.
        Returns:
        UserInformation

      • getEnableConnectForUser

        public String getEnableConnectForUser()
        Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false..
        Returns:
        enableConnectForUser

      • setEnableConnectForUser

        public void setEnableConnectForUser​(String enableConnectForUser)
        setEnableConnectForUser.

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        This object describes errors that occur. It is only valid for responses and ignored in requests..
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • getFirstName

        public String getFirstName()
        The user's first name. Maximum Length: 50 characters..
        Returns:
        firstName

      • setFirstName

        public void setFirstName​(String firstName)
        setFirstName.

      • getForgottenPasswordInfo

        public ForgottenPasswordInformation getForgottenPasswordInfo()
        A complex element containing up to four Question/Answer pairs for forgotten password information..
        Returns:
        forgottenPasswordInfo

      • setForgottenPasswordInfo

        public void setForgottenPasswordInfo​(ForgottenPasswordInformation forgottenPasswordInfo)
        setForgottenPasswordInfo.

      • addGroupListItem

        public UserInformation addGroupListItem​(Group groupListItem)
        addGroupListItem.
        Returns:
        UserInformation

      • getGroupList

        public List<Group> getGroupList()
        A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId - The DocuSign group ID for the group. * groupName - The name of the group * permissionProfileId - The ID of the permission profile associated with the group. * groupType - The group type. .
        Returns:
        groupList

      • setGroupList

        public void setGroupList​(List<Group> groupList)
        setGroupList.

      • hasRemoteNotary

        public UserInformation hasRemoteNotary​(Boolean hasRemoteNotary)
        hasRemoteNotary.
        Returns:
        UserInformation

      • isHasRemoteNotary

        public Boolean isHasRemoteNotary()
        .
        Returns:
        hasRemoteNotary

      • setHasRemoteNotary

        public void setHasRemoteNotary​(Boolean hasRemoteNotary)
        setHasRemoteNotary.

      • getHomeAddress

        public AddressInformation getHomeAddress()
        Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters..
        Returns:
        homeAddress

      • setHomeAddress

        public void setHomeAddress​(AddressInformation homeAddress)
        setHomeAddress.

      • initialsImageUri

        public UserInformation initialsImageUri​(String initialsImageUri)
        initialsImageUri.
        Returns:
        UserInformation

      • getInitialsImageUri

        public String getInitialsImageUri()
        Contains the URI for an endpoint that you can use to retrieve the initials image..
        Returns:
        initialsImageUri

      • setInitialsImageUri

        public void setInitialsImageUri​(String initialsImageUri)
        setInitialsImageUri.

      • getIsAdmin

        public String getIsAdmin()
        Determines if the feature set is actively set as part of the plan..
        Returns:
        isAdmin

      • setIsAdmin

        public void setIsAdmin​(String isAdmin)
        setIsAdmin.

      • isAlternateAdmin

        public UserInformation isAlternateAdmin​(String isAlternateAdmin)
        isAlternateAdmin.
        Returns:
        UserInformation

      • getIsAlternateAdmin

        public String getIsAlternateAdmin()
        .
        Returns:
        isAlternateAdmin

      • setIsAlternateAdmin

        public void setIsAlternateAdmin​(String isAlternateAdmin)
        setIsAlternateAdmin.

      • isNAREnabled

        public UserInformation isNAREnabled​(String isNAREnabled)
        isNAREnabled.
        Returns:
        UserInformation

      • getIsNAREnabled

        public String getIsNAREnabled()
        .
        Returns:
        isNAREnabled

      • setIsNAREnabled

        public void setIsNAREnabled​(String isNAREnabled)
        setIsNAREnabled.

      • getJobTitle

        public String getJobTitle()
        .
        Returns:
        jobTitle

      • setJobTitle

        public void setJobTitle​(String jobTitle)
        setJobTitle.

      • getLastLogin

        public String getLastLogin()
        Shows the date-time when the user last logged on to the system..
        Returns:
        lastLogin

      • setLastLogin

        public void setLastLogin​(String lastLogin)
        setLastLogin.

      • getLastName

        public String getLastName()
        The user's last name. Maximum Length: 50 characters..
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)
        setLastName.

      • loginStatus

        public UserInformation loginStatus​(String loginStatus)
        loginStatus.
        Returns:
        UserInformation

      • getLoginStatus

        public String getLoginStatus()
        Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed .
        Returns:
        loginStatus

      • setLoginStatus

        public void setLoginStatus​(String loginStatus)
        setLoginStatus.

      • middleName

        public UserInformation middleName​(String middleName)
        middleName.
        Returns:
        UserInformation

      • getMiddleName

        public String getMiddleName()
        The user's middle name. Maximum Length: 50 characters..
        Returns:
        middleName

      • setMiddleName

        public void setMiddleName​(String middleName)
        setMiddleName.

      • getPassword

        public String getPassword()
        .
        Returns:
        password

      • setPassword

        public void setPassword​(String password)
        setPassword.

      • passwordExpiration

        public UserInformation passwordExpiration​(String passwordExpiration)
        passwordExpiration.
        Returns:
        UserInformation

      • getPasswordExpiration

        public String getPasswordExpiration()
        .
        Returns:
        passwordExpiration

      • setPasswordExpiration

        public void setPasswordExpiration​(String passwordExpiration)
        setPasswordExpiration.

      • permissionProfileId

        public UserInformation permissionProfileId​(String permissionProfileId)
        permissionProfileId.
        Returns:
        UserInformation

      • getPermissionProfileId

        public String getPermissionProfileId()
        .
        Returns:
        permissionProfileId

      • setPermissionProfileId

        public void setPermissionProfileId​(String permissionProfileId)
        setPermissionProfileId.

      • permissionProfileName

        public UserInformation permissionProfileName​(String permissionProfileName)
        permissionProfileName.
        Returns:
        UserInformation

      • getPermissionProfileName

        public String getPermissionProfileName()
        .
        Returns:
        permissionProfileName

      • setPermissionProfileName

        public void setPermissionProfileName​(String permissionProfileName)
        setPermissionProfileName.

      • profileImageUri

        public UserInformation profileImageUri​(String profileImageUri)
        profileImageUri.
        Returns:
        UserInformation

      • getProfileImageUri

        public String getProfileImageUri()
        .
        Returns:
        profileImageUri

      • setProfileImageUri

        public void setProfileImageUri​(String profileImageUri)
        setProfileImageUri.

      • sendActivationEmail

        public UserInformation sendActivationEmail​(String sendActivationEmail)
        sendActivationEmail.
        Returns:
        UserInformation

      • getSendActivationEmail

        public String getSendActivationEmail()
        .
        Returns:
        sendActivationEmail

      • setSendActivationEmail

        public void setSendActivationEmail​(String sendActivationEmail)
        setSendActivationEmail.

      • sendActivationOnInvalidLogin

        public UserInformation sendActivationOnInvalidLogin​(String sendActivationOnInvalidLogin)
        sendActivationOnInvalidLogin.
        Returns:
        UserInformation

      • getSendActivationOnInvalidLogin

        public String getSendActivationOnInvalidLogin()
        When set to **true**, specifies that an additional activation email is sent to the user if they fail a log on before activating their account. .
        Returns:
        sendActivationOnInvalidLogin

      • setSendActivationOnInvalidLogin

        public void setSendActivationOnInvalidLogin​(String sendActivationOnInvalidLogin)
        setSendActivationOnInvalidLogin.

      • signatureImageUri

        public UserInformation signatureImageUri​(String signatureImageUri)
        signatureImageUri.
        Returns:
        UserInformation

      • getSignatureImageUri

        public String getSignatureImageUri()
        Contains the URI for an endpoint that you can use to retrieve the signature image..
        Returns:
        signatureImageUri

      • setSignatureImageUri

        public void setSignatureImageUri​(String signatureImageUri)
        setSignatureImageUri.

      • getSubscribe

        public String getSubscribe()
        .
        Returns:
        subscribe

      • setSubscribe

        public void setSubscribe​(String subscribe)
        setSubscribe.

      • suffixName

        public UserInformation suffixName​(String suffixName)
        suffixName.
        Returns:
        UserInformation

      • getSuffixName

        public String getSuffixName()
        The suffix for the user's name. Maximum Length: 50 characters. .
        Returns:
        suffixName

      • setSuffixName

        public void setSuffixName​(String suffixName)
        setSuffixName.

      • getTitle

        public String getTitle()
        The title of the user..
        Returns:
        title

      • setTitle

        public void setTitle​(String title)
        setTitle.

      • getUri

        public String getUri()
        .
        Returns:
        uri

      • setUri

        public void setUri​(String uri)
        setUri.

      • userAddedToAccountDateTime

        public UserInformation userAddedToAccountDateTime​(String userAddedToAccountDateTime)
        userAddedToAccountDateTime.
        Returns:
        UserInformation

      • getUserAddedToAccountDateTime

        public String getUserAddedToAccountDateTime()
        .
        Returns:
        userAddedToAccountDateTime

      • setUserAddedToAccountDateTime

        public void setUserAddedToAccountDateTime​(String userAddedToAccountDateTime)
        setUserAddedToAccountDateTime.

      • getUserId

        public String getUserId()
        .
        Returns:
        userId

      • setUserId

        public void setUserId​(String userId)
        setUserId.

      • getUserName

        public String getUserName()
        .
        Returns:
        userName

      • setUserName

        public void setUserName​(String userName)
        setUserName.

      • userProfileLastModifiedDate

        public UserInformation userProfileLastModifiedDate​(String userProfileLastModifiedDate)
        userProfileLastModifiedDate.
        Returns:
        UserInformation

      • getUserProfileLastModifiedDate

        public String getUserProfileLastModifiedDate()
        .
        Returns:
        userProfileLastModifiedDate

      • setUserProfileLastModifiedDate

        public void setUserProfileLastModifiedDate​(String userProfileLastModifiedDate)
        setUserProfileLastModifiedDate.

      • getUserSettings

        public UserSettingsInformation getUserSettings()
        The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings..
        Returns:
        userSettings

      • userStatus

        public UserInformation userStatus​(String userStatus)
        userStatus.
        Returns:
        UserInformation

      • getUserStatus

        public String getUserStatus()
        .
        Returns:
        userStatus

      • setUserStatus

        public void setUserStatus​(String userStatus)
        setUserStatus.

      • getUserType

        public String getUserType()
        .
        Returns:
        userType

      • setUserType

        public void setUserType​(String userType)
        setUserType.

      • setWorkAddress

        public void setWorkAddress​(AddressInformation workAddress)
        setWorkAddress.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object