com.docusign.esign.model

Class ConnectCustomConfiguration

java.lang.Object

com.docusign.esign.model.ConnectCustomConfiguration

public class ConnectCustomConfiguration
extends Object

ConnectCustomConfiguration

Constructor Summary

Constructors

Constructor and Description
ConnectCustomConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
ConnectCustomConfiguration	allowEnvelopePublish(String allowEnvelopePublish)
ConnectCustomConfiguration	allUsers(String allUsers)
ConnectCustomConfiguration	configurationType(String configurationType)
ConnectCustomConfiguration	connectId(String connectId)
ConnectCustomConfiguration	enableLog(String enableLog)
ConnectCustomConfiguration	envelopeEvents(String envelopeEvents)
boolean	equals(Object o)
String	getAllowEnvelopePublish() When set to **true**, data is sent to the urlToPublishTo web address.
String	getAllUsers() When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.
String	getConfigurationType() If merge field's are being used, specifies the type of the merge field.
String	getConnectId() Specifies the DocuSign generated ID for the Connect configuration.
String	getEnableLog() This turns Connect logging on or off.
String	getEnvelopeEvents() A comma separated list of �Envelope� related events that are tracked through Connect.
String	getIncludeCertificateOfCompletion() When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes.
String	getIncludeCertSoapHeader()
String	getIncludeDocumentFields() When set to **true**, the Document Fields associated with envelope documents are included in the data.
String	getIncludeDocuments() When set to **true**, Connect will send the PDF document along with the update XML.
String	getIncludeEnvelopeVoidReason() When set to **true**, Connect will include the voidedReason for voided envelopes.
String	getIncludeSenderAccountasCustomField() When set to **true**, Connect will include the sender account as Custom Field in the data.
String	getIncludeTimeZoneInformation() When set to **true**, Connect will include the envelope time zone information.
String	getName() The name of the Connect configuration.
String	getRecipientEvents() A comma separated list of �Recipient� related events that are tracked through Connect.
String	getRequiresAcknowledgement() When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received.
String	getSignMessageWithX509Certificate() When set to **true**, Connect messages are signed with an X509 certificate.
String	getSoapNamespace() The namespace of the SOAP interface.
String	getUrlToPublishTo() This is the web address and name of your listener or Retrieving Service endpoint.
String	getUserIds() A comma separated list of userIds.
String	getUseSoapInterface() When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint.
int	hashCode()
ConnectCustomConfiguration	includeCertificateOfCompletion(String includeCertificateOfCompletion)
ConnectCustomConfiguration	includeCertSoapHeader(String includeCertSoapHeader)
ConnectCustomConfiguration	includeDocumentFields(String includeDocumentFields)
ConnectCustomConfiguration	includeDocuments(String includeDocuments)
ConnectCustomConfiguration	includeEnvelopeVoidReason(String includeEnvelopeVoidReason)
ConnectCustomConfiguration	includeSenderAccountasCustomField(String includeSenderAccountasCustomField)
ConnectCustomConfiguration	includeTimeZoneInformation(String includeTimeZoneInformation)
ConnectCustomConfiguration	name(String name)
ConnectCustomConfiguration	recipientEvents(String recipientEvents)
ConnectCustomConfiguration	requiresAcknowledgement(String requiresAcknowledgement)
void	setAllowEnvelopePublish(String allowEnvelopePublish)
void	setAllUsers(String allUsers)
void	setConfigurationType(String configurationType)
void	setConnectId(String connectId)
void	setEnableLog(String enableLog)
void	setEnvelopeEvents(String envelopeEvents)
void	setIncludeCertificateOfCompletion(String includeCertificateOfCompletion)
void	setIncludeCertSoapHeader(String includeCertSoapHeader)
void	setIncludeDocumentFields(String includeDocumentFields)
void	setIncludeDocuments(String includeDocuments)
void	setIncludeEnvelopeVoidReason(String includeEnvelopeVoidReason)
void	setIncludeSenderAccountasCustomField(String includeSenderAccountasCustomField)
void	setIncludeTimeZoneInformation(String includeTimeZoneInformation)
void	setName(String name)
void	setRecipientEvents(String recipientEvents)
void	setRequiresAcknowledgement(String requiresAcknowledgement)
void	setSignMessageWithX509Certificate(String signMessageWithX509Certificate)
void	setSoapNamespace(String soapNamespace)
void	setUrlToPublishTo(String urlToPublishTo)
void	setUserIds(String userIds)
void	setUseSoapInterface(String useSoapInterface)
ConnectCustomConfiguration	signMessageWithX509Certificate(String signMessageWithX509Certificate)
ConnectCustomConfiguration	soapNamespace(String soapNamespace)
String	toString()
ConnectCustomConfiguration	urlToPublishTo(String urlToPublishTo)
ConnectCustomConfiguration	userIds(String userIds)
ConnectCustomConfiguration	useSoapInterface(String useSoapInterface)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectCustomConfiguration

public ConnectCustomConfiguration()

Method Detail

allowEnvelopePublish

public ConnectCustomConfiguration allowEnvelopePublish(String allowEnvelopePublish)

getAllowEnvelopePublish

public String getAllowEnvelopePublish()

When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.

Returns:

allowEnvelopePublish

setAllowEnvelopePublish

public void setAllowEnvelopePublish(String allowEnvelopePublish)

allUsers

public ConnectCustomConfiguration allUsers(String allUsers)

getAllUsers

public String getAllUsers()

When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.

Returns:

allUsers

setAllUsers

public void setAllUsers(String allUsers)

configurationType

public ConnectCustomConfiguration configurationType(String configurationType)

getConfigurationType

public String getConfigurationType()

If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.

Returns:

configurationType

setConfigurationType

public void setConfigurationType(String configurationType)

connectId

public ConnectCustomConfiguration connectId(String connectId)

getConnectId

public String getConnectId()

Specifies the DocuSign generated ID for the Connect configuration.

Returns:

connectId

setConnectId

public void setConnectId(String connectId)

enableLog

public ConnectCustomConfiguration enableLog(String enableLog)

getEnableLog

public String getEnableLog()

This turns Connect logging on or off. When set to **true**, logging is turned on.

Returns:

enableLog

setEnableLog

public void setEnableLog(String enableLog)

envelopeEvents

public ConnectCustomConfiguration envelopeEvents(String envelopeEvents)

getEnvelopeEvents

public String getEnvelopeEvents()

A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.

Returns:

envelopeEvents

setEnvelopeEvents

public void setEnvelopeEvents(String envelopeEvents)

includeCertificateOfCompletion

public ConnectCustomConfiguration includeCertificateOfCompletion(String includeCertificateOfCompletion)

getIncludeCertificateOfCompletion

public String getIncludeCertificateOfCompletion()

When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes.

Returns:

includeCertificateOfCompletion

setIncludeCertificateOfCompletion

public void setIncludeCertificateOfCompletion(String includeCertificateOfCompletion)

includeCertSoapHeader

public ConnectCustomConfiguration includeCertSoapHeader(String includeCertSoapHeader)

getIncludeCertSoapHeader

public String getIncludeCertSoapHeader()

Returns:

includeCertSoapHeader

setIncludeCertSoapHeader

public void setIncludeCertSoapHeader(String includeCertSoapHeader)

includeDocumentFields

public ConnectCustomConfiguration includeDocumentFields(String includeDocumentFields)

getIncludeDocumentFields

public String getIncludeDocumentFields()

When set to **true**, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API.

Returns:

includeDocumentFields

setIncludeDocumentFields

public void setIncludeDocumentFields(String includeDocumentFields)

includeDocuments

public ConnectCustomConfiguration includeDocuments(String includeDocuments)

getIncludeDocuments

public String getIncludeDocuments()

When set to **true**, Connect will send the PDF document along with the update XML.

Returns:

includeDocuments

setIncludeDocuments

public void setIncludeDocuments(String includeDocuments)

includeEnvelopeVoidReason

public ConnectCustomConfiguration includeEnvelopeVoidReason(String includeEnvelopeVoidReason)

getIncludeEnvelopeVoidReason

public String getIncludeEnvelopeVoidReason()

When set to **true**, Connect will include the voidedReason for voided envelopes.

Returns:

includeEnvelopeVoidReason

setIncludeEnvelopeVoidReason

public void setIncludeEnvelopeVoidReason(String includeEnvelopeVoidReason)

includeSenderAccountasCustomField

public ConnectCustomConfiguration includeSenderAccountasCustomField(String includeSenderAccountasCustomField)

getIncludeSenderAccountasCustomField

public String getIncludeSenderAccountasCustomField()

When set to **true**, Connect will include the sender account as Custom Field in the data.

Returns:

includeSenderAccountasCustomField

setIncludeSenderAccountasCustomField

public void setIncludeSenderAccountasCustomField(String includeSenderAccountasCustomField)

includeTimeZoneInformation

public ConnectCustomConfiguration includeTimeZoneInformation(String includeTimeZoneInformation)

getIncludeTimeZoneInformation

public String getIncludeTimeZoneInformation()

When set to **true**, Connect will include the envelope time zone information.

Returns:

includeTimeZoneInformation

setIncludeTimeZoneInformation

public void setIncludeTimeZoneInformation(String includeTimeZoneInformation)

name

public ConnectCustomConfiguration name(String name)

getName

public String getName()

The name of the Connect configuration. The name helps identify the configuration in the list.

Returns:

name

setName

public void setName(String name)

recipientEvents

public ConnectCustomConfiguration recipientEvents(String recipientEvents)

getRecipientEvents

public String getRecipientEvents()

A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.

Returns:

recipientEvents

setRecipientEvents

public void setRecipientEvents(String recipientEvents)

requiresAcknowledgement

public ConnectCustomConfiguration requiresAcknowledgement(String requiresAcknowledgement)

getRequiresAcknowledgement

public String getRequiresAcknowledgement()

When set to **true**, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information.

Returns:

requiresAcknowledgement

setRequiresAcknowledgement

public void setRequiresAcknowledgement(String requiresAcknowledgement)

signMessageWithX509Certificate

public ConnectCustomConfiguration signMessageWithX509Certificate(String signMessageWithX509Certificate)

getSignMessageWithX509Certificate

public String getSignMessageWithX509Certificate()

When set to **true**, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.

Returns:

signMessageWithX509Certificate

setSignMessageWithX509Certificate

public void setSignMessageWithX509Certificate(String signMessageWithX509Certificate)

soapNamespace

public ConnectCustomConfiguration soapNamespace(String soapNamespace)

getSoapNamespace

public String getSoapNamespace()

The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.

Returns:

soapNamespace

setSoapNamespace

public void setSoapNamespace(String soapNamespace)

urlToPublishTo

public ConnectCustomConfiguration urlToPublishTo(String urlToPublishTo)

getUrlToPublishTo

public String getUrlToPublishTo()

This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.

Returns:

urlToPublishTo

setUrlToPublishTo

public void setUrlToPublishTo(String urlToPublishTo)

userIds

public ConnectCustomConfiguration userIds(String userIds)

getUserIds

public String getUserIds()

A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.

Returns:

userIds

setUserIds

public void setUserIds(String userIds)

useSoapInterface

public ConnectCustomConfiguration useSoapInterface(String useSoapInterface)

getUseSoapInterface

public String getUseSoapInterface()

When set to **true**, indicates that the `urlToPublishTo` property contains a SOAP endpoint.

Returns:

useSoapInterface

setUseSoapInterface

public void setUseSoapInterface(String useSoapInterface)

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