com.docusign.esign.model

Class LoginAccount

java.lang.Object

com.docusign.esign.model.LoginAccount

public class LoginAccount
extends Object

LoginAccount

Constructor Summary

Constructors

Constructor and Description
LoginAccount()

Method Summary

Methods

Modifier and Type	Method and Description
LoginAccount	accountId(String accountId)
LoginAccount	accountIdGuid(String accountIdGuid)
LoginAccount	addLoginAccountSettingsItem(NameValue loginAccountSettingsItem)
LoginAccount	addLoginUserSettingsItem(NameValue loginUserSettingsItem)
LoginAccount	baseUrl(String baseUrl)
LoginAccount	email(String email)
boolean	equals(Object o)
String	getAccountId() The account ID associated with the envelope.
String	getAccountIdGuid() The GUID associated with the account ID.
String	getBaseUrl() The URL that should be used for successive calls to this account.
String	getEmail() The email address for the user.
String	getIsDefault() 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.
String	getName() The name associated with the account.
String	getSiteDescription() An optional descirption of the site that hosts the account.
String	getUserId()
String	getUserName() The name of this user as defined by the account.
int	hashCode()
LoginAccount	isDefault(String isDefault)
LoginAccount	loginAccountSettings(List<NameValue> loginAccountSettings)
LoginAccount	loginUserSettings(List<NameValue> loginUserSettings)
LoginAccount	name(String name)
void	setAccountId(String accountId)
void	setAccountIdGuid(String accountIdGuid)
void	setBaseUrl(String baseUrl)
void	setEmail(String email)
void	setIsDefault(String isDefault)
void	setLoginAccountSettings(List<NameValue> loginAccountSettings)
void	setLoginUserSettings(List<NameValue> loginUserSettings)
void	setName(String name)
void	setSiteDescription(String siteDescription)
void	setUserId(String userId)
void	setUserName(String userName)
LoginAccount	siteDescription(String siteDescription)
String	toString()
LoginAccount	userId(String userId)
LoginAccount	userName(String userName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LoginAccount

public LoginAccount()

Method Detail

accountId

public LoginAccount accountId(String accountId)

getAccountId

public String getAccountId()

The account ID associated with the envelope.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

accountIdGuid

public LoginAccount accountIdGuid(String accountIdGuid)

getAccountIdGuid

public String getAccountIdGuid()

The GUID associated with the account ID.

Returns:

accountIdGuid

setAccountIdGuid

public void setAccountIdGuid(String accountIdGuid)

baseUrl

public LoginAccount baseUrl(String baseUrl)

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)

email

public LoginAccount email(String email)

getEmail

public String getEmail()

The email address for the user.

Returns:

email

setEmail

public void setEmail(String email)

isDefault

public LoginAccount isDefault(String isDefault)

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)

loginAccountSettings

public LoginAccount loginAccountSettings(List<NameValue> loginAccountSettings)

addLoginAccountSettingsItem

public LoginAccount addLoginAccountSettingsItem(NameValue loginAccountSettingsItem)

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)

loginUserSettings

public LoginAccount loginUserSettings(List<NameValue> loginUserSettings)

addLoginUserSettingsItem

public LoginAccount addLoginUserSettingsItem(NameValue loginUserSettingsItem)

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)

name

public LoginAccount name(String name)

getName

public String getName()

The name associated with the account.

Returns:

name

setName

public void setName(String name)

siteDescription

public LoginAccount siteDescription(String siteDescription)

getSiteDescription

public String getSiteDescription()

An optional descirption of the site that hosts the account.

Returns:

siteDescription

setSiteDescription

public void setSiteDescription(String siteDescription)

userId

public LoginAccount userId(String userId)

getUserId

public String getUserId()

Returns:

userId

setUserId

public void setUserId(String userId)

userName

public LoginAccount userName(String userName)

getUserName

public String getUserName()

The name of this user as defined by the account.

Returns:

userName

setUserName

public void setUserName(String userName)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object