Package com.docusign.esign.model

Class CaptiveRecipient

java.lang.Object

com.docusign.esign.model.CaptiveRecipient

public class CaptiveRecipient
extends Object

This object contains details about a captive (embedded) recipient..

Constructor Summary

Constructors

Constructor	Description
CaptiveRecipient()

Method Summary

Modifier and Type	Method	Description
CaptiveRecipient	clientUserId(String clientUserId)	clientUserId.
CaptiveRecipient	email(String email)	email.
boolean	equals(Object o)	Compares objects.
CaptiveRecipient	errorDetails(ErrorDetails errorDetails)	errorDetails.
String	getClientUserId()	Specifies whether the recipient is embedded or remote.
String	getEmail()	Specifies the email address associated with the captive recipient..
ErrorDetails	getErrorDetails()	This object describes errors that occur.
String	getUserName()	Specifies the user name associated with the captive recipient..
int	hashCode()	Returns the HashCode.
void	setClientUserId(String clientUserId)	setClientUserId.
void	setEmail(String email)	setEmail.
void	setErrorDetails(ErrorDetails errorDetails)	setErrorDetails.
void	setUserName(String userName)	setUserName.
String	toString()	Converts the given object to string.
CaptiveRecipient	userName(String userName)	userName.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptiveRecipient

public CaptiveRecipient()

Method Detail

clientUserId

public CaptiveRecipient clientUserId(String clientUserId)

clientUserId.

Returns:

CaptiveRecipient

getClientUserId

public String getClientUserId()

Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. .

Returns:

clientUserId

setClientUserId

public void setClientUserId(String clientUserId)

setClientUserId.

email

public CaptiveRecipient email(String email)

email.

Returns:

CaptiveRecipient

getEmail

public String getEmail()

Specifies the email address associated with the captive recipient..

Returns:

email

setEmail

public void setEmail(String email)

setEmail.

errorDetails

public CaptiveRecipient errorDetails(ErrorDetails errorDetails)

errorDetails.

Returns:

CaptiveRecipient

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.

userName

public CaptiveRecipient userName(String userName)

userName.

Returns:

CaptiveRecipient

getUserName

public String getUserName()

Specifies the user name associated with the captive recipient..

Returns:

userName

setUserName

public void setUserName(String userName)

setUserName.

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