Package com.docusign.esign.model
Class LoginAccount
- java.lang.Object
-
- com.docusign.esign.model.LoginAccount
-
public class LoginAccount extends Object
LoginAccount.
-
-
Constructor Summary
Constructors Constructor Description LoginAccount()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoginAccountaccountId(String accountId)accountId.LoginAccountaccountIdGuid(String accountIdGuid)accountIdGuid.LoginAccountaddLoginAccountSettingsItem(NameValue loginAccountSettingsItem)addLoginAccountSettingsItem.LoginAccountaddLoginUserSettingsItem(NameValue loginUserSettingsItem)addLoginUserSettingsItem.LoginAccountbaseUrl(String baseUrl)baseUrl.LoginAccountemail(String email)email.booleanequals(Object o)Compares objects.StringgetAccountId()The account ID associated with the envelope..StringgetAccountIdGuid()The GUID associated with the account ID..StringgetBaseUrl()The URL that should be used for successive calls to this account.StringgetEmail()The email address for the user..StringgetIsDefault()This value is true if this is the default account for the user, otherwise false is returned..List<NameValue>getLoginAccountSettings()A list of settings on the acccount that indicate what features are available..List<NameValue>getLoginUserSettings()A list of user-level settings that indicate what user-specific features are available..StringgetName()The name associated with the account..StringgetSiteDescription()An optional descirption of the site that hosts the account..StringgetUserId().StringgetUserName()The name of this user as defined by the account..inthashCode()Returns the HashCode.LoginAccountisDefault(String isDefault)isDefault.LoginAccountloginAccountSettings(List<NameValue> loginAccountSettings)loginAccountSettings.LoginAccountloginUserSettings(List<NameValue> loginUserSettings)loginUserSettings.LoginAccountname(String name)name.voidsetAccountId(String accountId)setAccountId.voidsetAccountIdGuid(String accountIdGuid)setAccountIdGuid.voidsetBaseUrl(String baseUrl)setBaseUrl.voidsetEmail(String email)setEmail.voidsetIsDefault(String isDefault)setIsDefault.voidsetLoginAccountSettings(List<NameValue> loginAccountSettings)setLoginAccountSettings.voidsetLoginUserSettings(List<NameValue> loginUserSettings)setLoginUserSettings.voidsetName(String name)setName.voidsetSiteDescription(String siteDescription)setSiteDescription.voidsetUserId(String userId)setUserId.voidsetUserName(String userName)setUserName.LoginAccountsiteDescription(String siteDescription)siteDescription.StringtoString()Converts the given object to string.LoginAccountuserId(String userId)userId.LoginAccountuserName(String userName)userName.
-
-
-
Method Detail
-
accountId
public LoginAccount accountId(String accountId)
accountId.- Returns:
- LoginAccount
-
getAccountId
public String getAccountId()
The account ID associated with the envelope..- Returns:
- accountId
-
setAccountId
public void setAccountId(String accountId)
setAccountId.
-
accountIdGuid
public LoginAccount accountIdGuid(String accountIdGuid)
accountIdGuid.- Returns:
- LoginAccount
-
getAccountIdGuid
public String getAccountIdGuid()
The GUID associated with the account ID..- Returns:
- accountIdGuid
-
setAccountIdGuid
public void setAccountIdGuid(String accountIdGuid)
setAccountIdGuid.
-
baseUrl
public LoginAccount baseUrl(String baseUrl)
baseUrl.- Returns:
- LoginAccount
-
getBaseUrl
public String getBaseUrl()
The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl..- Returns:
- baseUrl
-
setBaseUrl
public void setBaseUrl(String baseUrl)
setBaseUrl.
-
email
public LoginAccount email(String email)
email.- Returns:
- LoginAccount
-
getEmail
public String getEmail()
The email address for the user..- Returns:
-
setEmail
public void setEmail(String email)
setEmail.
-
isDefault
public LoginAccount isDefault(String isDefault)
isDefault.- Returns:
- LoginAccount
-
getIsDefault
public String getIsDefault()
This value is true if this is the default account for the user, otherwise false is returned..- Returns:
- isDefault
-
setIsDefault
public void setIsDefault(String isDefault)
setIsDefault.
-
loginAccountSettings
public LoginAccount loginAccountSettings(List<NameValue> loginAccountSettings)
loginAccountSettings.- Returns:
- LoginAccount
-
addLoginAccountSettingsItem
public LoginAccount addLoginAccountSettingsItem(NameValue loginAccountSettingsItem)
addLoginAccountSettingsItem.- Returns:
- LoginAccount
-
getLoginAccountSettings
public List<NameValue> getLoginAccountSettings()
A list of settings on the acccount that indicate what features are available..- Returns:
- loginAccountSettings
-
setLoginAccountSettings
public void setLoginAccountSettings(List<NameValue> loginAccountSettings)
setLoginAccountSettings.
-
loginUserSettings
public LoginAccount loginUserSettings(List<NameValue> loginUserSettings)
loginUserSettings.- Returns:
- LoginAccount
-
addLoginUserSettingsItem
public LoginAccount addLoginUserSettingsItem(NameValue loginUserSettingsItem)
addLoginUserSettingsItem.- Returns:
- LoginAccount
-
getLoginUserSettings
public List<NameValue> getLoginUserSettings()
A list of user-level settings that indicate what user-specific features are available..- Returns:
- loginUserSettings
-
setLoginUserSettings
public void setLoginUserSettings(List<NameValue> loginUserSettings)
setLoginUserSettings.
-
name
public LoginAccount name(String name)
name.- Returns:
- LoginAccount
-
getName
public String getName()
The name associated with the account..- Returns:
- name
-
setName
public void setName(String name)
setName.
-
siteDescription
public LoginAccount siteDescription(String siteDescription)
siteDescription.- Returns:
- LoginAccount
-
getSiteDescription
public String getSiteDescription()
An optional descirption of the site that hosts the account..- Returns:
- siteDescription
-
setSiteDescription
public void setSiteDescription(String siteDescription)
setSiteDescription.
-
userId
public LoginAccount userId(String userId)
userId.- Returns:
- LoginAccount
-
getUserId
public String getUserId()
.- Returns:
- userId
-
setUserId
public void setUserId(String userId)
setUserId.
-
userName
public LoginAccount userName(String userName)
userName.- Returns:
- LoginAccount
-
getUserName
public String getUserName()
The name of this user as defined by the account..- Returns:
- userName
-
setUserName
public void setUserName(String userName)
setUserName.
-
equals
public boolean equals(Object o)
Compares objects.
-
-