Package com.docusign.webforms.model

Class CreateInstanceRequestBody

java.lang.Object

com.docusign.webforms.model.CreateInstanceRequestBody

All Implemented Interfaces:

Serializable

public class CreateInstanceRequestBody
extends Object
implements Serializable

Request body containing properties that will be used to create instance..

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CreateInstanceRequestBody()

Method Summary

Modifier and Type	Method	Description
CreateInstanceRequestBody	addRecipientsItem(CreateInstanceRequestBodyRecipients recipientsItem)	addRecipientsItem.
CreateInstanceRequestBody	addTagsItem(String tagsItem)	addTagsItem.
CreateInstanceRequestBody	assertionId(String assertionId)	assertionId.
CreateInstanceRequestBody	authenticationInstant(String authenticationInstant)	authenticationInstant.
CreateInstanceRequestBody	authenticationMethod(AuthenticationMethod authenticationMethod)	authenticationMethod.
CreateInstanceRequestBody	brandId(String brandId)	brandId.
CreateInstanceRequestBody	clientUserId(String clientUserId)	clientUserId.
boolean	equals(Object o)	Compares objects.
CreateInstanceRequestBody	expirationOffset(Integer expirationOffset)	expirationOffset.
CreateInstanceRequestBody	formValues(Map<String,Object> formValues)	formValues.
String	getAssertionId()	Get assertionId.
String	getAuthenticationInstant()	Get authenticationInstant.
AuthenticationMethod	getAuthenticationMethod()	Get authenticationMethod.
String	getBrandId()	Get brandId.
String	getClientUserId()	Get clientUserId.
Integer	getExpirationOffset()	Get expirationOffset.
Map<String,Object>	getFormValues()	Key-value pairs (where key is the component name and value is the form value) used to create a form instance.
List<CreateInstanceRequestBodyRecipients>	getRecipients()	The recipients who will receive the form in email.
String	getReturnUrl()	Get returnUrl.
String	getSecurityDomain()	Get securityDomain.
SendOption	getSendOption()	Get sendOption.
List<String>	getTags()	List of tags provided by the user with each request.
int	hashCode()	Returns the HashCode.
CreateInstanceRequestBody	putFormValuesItem(String key, Object formValuesItem)	putFormValuesItem.
CreateInstanceRequestBody	recipients(List<CreateInstanceRequestBodyRecipients> recipients)	recipients.
CreateInstanceRequestBody	returnUrl(String returnUrl)	returnUrl.
CreateInstanceRequestBody	securityDomain(String securityDomain)	securityDomain.
CreateInstanceRequestBody	sendOption(SendOption sendOption)	sendOption.
void	setAssertionId(String assertionId)	setAssertionId.
void	setAuthenticationInstant(String authenticationInstant)	setAuthenticationInstant.
void	setAuthenticationMethod(AuthenticationMethod authenticationMethod)	setAuthenticationMethod.
void	setBrandId(String brandId)	setBrandId.
void	setClientUserId(String clientUserId)	setClientUserId.
void	setExpirationOffset(Integer expirationOffset)	setExpirationOffset.
void	setFormValues(Map<String,Object> formValues)	setFormValues.
void	setRecipients(List<CreateInstanceRequestBodyRecipients> recipients)	setRecipients.
void	setReturnUrl(String returnUrl)	setReturnUrl.
void	setSecurityDomain(String securityDomain)	setSecurityDomain.
void	setSendOption(SendOption sendOption)	setSendOption.
void	setTags(List<String> tags)	setTags.
CreateInstanceRequestBody	tags(List<String> tags)	tags.
String	toString()	Converts the given object to string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateInstanceRequestBody

public CreateInstanceRequestBody()

Method Detail

formValues

public CreateInstanceRequestBody formValues(Map<String,Object> formValues)

formValues.

Returns:

CreateInstanceRequestBody

putFormValuesItem

public CreateInstanceRequestBody putFormValuesItem(String key,
                                                   Object formValuesItem)

putFormValuesItem.

Returns:

CreateInstanceRequestBody

getFormValues

public Map<String,Object> getFormValues()

Key-value pairs (where key is the component name and value is the form value) used to create a form instance. For key of type TextBox, Email, Date, Select and RadioButtonGroup the value is of string type. For key of type Number, the value is of number type. For key of type of CheckboxGroup, the value is of type array of string..

Returns:

formValues

setFormValues

public void setFormValues(Map<String,Object> formValues)

setFormValues.

clientUserId

public CreateInstanceRequestBody clientUserId(String clientUserId)

clientUserId.

Returns:

CreateInstanceRequestBody

getClientUserId

public String getClientUserId()

Get clientUserId.

Returns:

clientUserId

setClientUserId

public void setClientUserId(String clientUserId)

setClientUserId.

authenticationInstant

public CreateInstanceRequestBody authenticationInstant(String authenticationInstant)

authenticationInstant.

Returns:

CreateInstanceRequestBody

getAuthenticationInstant

public String getAuthenticationInstant()

Get authenticationInstant.

Returns:

authenticationInstant

setAuthenticationInstant

public void setAuthenticationInstant(String authenticationInstant)

setAuthenticationInstant.

authenticationMethod

public CreateInstanceRequestBody authenticationMethod(AuthenticationMethod authenticationMethod)

authenticationMethod.

Returns:

CreateInstanceRequestBody

getAuthenticationMethod

public AuthenticationMethod getAuthenticationMethod()

Get authenticationMethod.

Returns:

authenticationMethod

setAuthenticationMethod

public void setAuthenticationMethod(AuthenticationMethod authenticationMethod)

setAuthenticationMethod.

assertionId

public CreateInstanceRequestBody assertionId(String assertionId)

assertionId.

Returns:

CreateInstanceRequestBody

getAssertionId

public String getAssertionId()

Get assertionId.

Returns:

assertionId

setAssertionId

public void setAssertionId(String assertionId)

setAssertionId.

securityDomain

public CreateInstanceRequestBody securityDomain(String securityDomain)

securityDomain.

Returns:

CreateInstanceRequestBody

getSecurityDomain

public String getSecurityDomain()

Get securityDomain.

Returns:

securityDomain

setSecurityDomain

public void setSecurityDomain(String securityDomain)

setSecurityDomain.

returnUrl

public CreateInstanceRequestBody returnUrl(String returnUrl)

returnUrl.

Returns:

CreateInstanceRequestBody

getReturnUrl

public String getReturnUrl()

Get returnUrl.

Returns:

returnUrl

setReturnUrl

public void setReturnUrl(String returnUrl)

setReturnUrl.

expirationOffset

public CreateInstanceRequestBody expirationOffset(Integer expirationOffset)

expirationOffset.

Returns:

CreateInstanceRequestBody

getExpirationOffset

public Integer getExpirationOffset()

Get expirationOffset.

Returns:

expirationOffset

setExpirationOffset

public void setExpirationOffset(Integer expirationOffset)

setExpirationOffset.

sendOption

public CreateInstanceRequestBody sendOption(SendOption sendOption)

sendOption.

Returns:

CreateInstanceRequestBody

getSendOption

public SendOption getSendOption()

Get sendOption.

Returns:

sendOption

setSendOption

public void setSendOption(SendOption sendOption)

setSendOption.

brandId

public CreateInstanceRequestBody brandId(String brandId)

brandId.

Returns:

CreateInstanceRequestBody

getBrandId

public String getBrandId()

Get brandId.

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

setBrandId.

recipients

public CreateInstanceRequestBody recipients(List<CreateInstanceRequestBodyRecipients> recipients)

recipients.

Returns:

CreateInstanceRequestBody

addRecipientsItem

public CreateInstanceRequestBody addRecipientsItem(CreateInstanceRequestBodyRecipients recipientsItem)

addRecipientsItem.

Returns:

CreateInstanceRequestBody

getRecipients

public List<CreateInstanceRequestBodyRecipients> getRecipients()

The recipients who will receive the form in email.

Returns:

recipients

setRecipients

public void setRecipients(List<CreateInstanceRequestBodyRecipients> recipients)

setRecipients.

tags

public CreateInstanceRequestBody tags(List<String> tags)

tags.

Returns:

CreateInstanceRequestBody

addTagsItem

public CreateInstanceRequestBody addTagsItem(String tagsItem)

addTagsItem.

Returns:

CreateInstanceRequestBody

getTags

public List<String> getTags()

List of tags provided by the user with each request. This field is optional..

Returns:

tags

setTags

public void setTags(List<String> tags)

setTags.

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