ConnectCustomConfiguration (docusign-esign-java 2.1.0 API)

java.lang.Object
- com.docusign.esign.model.ConnectCustomConfiguration

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class ConnectCustomConfiguration
extends Object

Constructor Summary

Constructors
Constructor and Description

ConnectCustomConfiguration()

Constructors
Constructor and Description
`ConnectCustomConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.\n\nThe namespace value must be set if useSoapInterface is set to true.
`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()`
`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)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConnectCustomConfiguration
```
public ConnectCustomConfiguration()
```
- Method Detail
  - 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.
  - setAllowEnvelopePublish
```
public void setAllowEnvelopePublish(String allowEnvelopePublish)
```
  - 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.
  - setAllUsers
```
public void setAllUsers(String allUsers)
```
  - getConfigurationType
```
public String getConfigurationType()
```
    If merge field’s are being used, specifies the type of the merge field. The only supported value is salesforce.
  - setConfigurationType
```
public void setConfigurationType(String configurationType)
```
  - getConnectId
```
public String getConnectId()
```
    Specifies the DocuSign generated ID for the Connect configuration.
  - setConnectId
```
public void setConnectId(String connectId)
```
  - getEnableLog
```
public String getEnableLog()
```
    This turns Connect logging on or off. When set to true, logging is turned on.
  - setEnableLog
```
public void setEnableLog(String enableLog)
```
  - 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.
  - setEnvelopeEvents
```
public void setEnvelopeEvents(String envelopeEvents)
```
  - getIncludeCertificateOfCompletion
```
public String getIncludeCertificateOfCompletion()
```
    When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.
  - setIncludeCertificateOfCompletion
```
public void setIncludeCertificateOfCompletion(String includeCertificateOfCompletion)
```
  - getIncludeCertSoapHeader
```
public String getIncludeCertSoapHeader()
```
  - setIncludeCertSoapHeader
```
public void setIncludeCertSoapHeader(String includeCertSoapHeader)
```
  - 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.
  - setIncludeDocumentFields
```
public void setIncludeDocumentFields(String includeDocumentFields)
```
  - getIncludeDocuments
```
public String getIncludeDocuments()
```
    When set to true, Connect will send the PDF document along with the update XML.
  - setIncludeDocuments
```
public void setIncludeDocuments(String includeDocuments)
```
  - getIncludeEnvelopeVoidReason
```
public String getIncludeEnvelopeVoidReason()
```
    When set to true, Connect will include the voidedReason for voided envelopes.
  - setIncludeEnvelopeVoidReason
```
public void setIncludeEnvelopeVoidReason(String includeEnvelopeVoidReason)
```
  - getIncludeSenderAccountasCustomField
```
public String getIncludeSenderAccountasCustomField()
```
    When set to true, Connect will include the sender account as Custom Field in the data.
  - setIncludeSenderAccountasCustomField
```
public void setIncludeSenderAccountasCustomField(String includeSenderAccountasCustomField)
```
  - getIncludeTimeZoneInformation
```
public String getIncludeTimeZoneInformation()
```
    When set to true, Connect will include the envelope time zone information.
  - setIncludeTimeZoneInformation
```
public void setIncludeTimeZoneInformation(String includeTimeZoneInformation)
```
  - getName
```
public String getName()
```
    The name of the Connect configuration. The name helps identify the configuration in the list.
  - setName
```
public void setName(String name)
```
  - 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.
  - setRecipientEvents
```
public void setRecipientEvents(String recipientEvents)
```
  - 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.
  - setRequiresAcknowledgement
```
public void setRequiresAcknowledgement(String requiresAcknowledgement)
```
  - getSignMessageWithX509Certificate
```
public String getSignMessageWithX509Certificate()
```
    When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.
  - setSignMessageWithX509Certificate
```
public void setSignMessageWithX509Certificate(String signMessageWithX509Certificate)
```
  - getSoapNamespace
```
public String getSoapNamespace()
```
    The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.
  - setSoapNamespace
```
public void setSoapNamespace(String soapNamespace)
```
  - 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.
  - setUrlToPublishTo
```
public void setUrlToPublishTo(String urlToPublishTo)
```
  - 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. \n\n###### Note: If allUsers is set to �false� then you must provide a list of user id�s.
  - setUserIds
```
public void setUserIds(String userIds)
```
  - getUseSoapInterface
```
public String getUseSoapInterface()
```
    When set to true, indicates that the urlToPublishTo property contains a SOAP endpoint.
  - 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

Class ConnectCustomConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectCustomConfiguration

Method Detail

getAllowEnvelopePublish

setAllowEnvelopePublish

getAllUsers

setAllUsers

getConfigurationType

setConfigurationType

getConnectId

setConnectId

getEnableLog

setEnableLog

getEnvelopeEvents

setEnvelopeEvents

getIncludeCertificateOfCompletion

setIncludeCertificateOfCompletion

getIncludeCertSoapHeader

setIncludeCertSoapHeader

getIncludeDocumentFields

setIncludeDocumentFields

getIncludeDocuments

setIncludeDocuments

getIncludeEnvelopeVoidReason

setIncludeEnvelopeVoidReason

getIncludeSenderAccountasCustomField

setIncludeSenderAccountasCustomField

getIncludeTimeZoneInformation

setIncludeTimeZoneInformation

getName

setName

getRecipientEvents

setRecipientEvents

getRequiresAcknowledgement

setRequiresAcknowledgement

getSignMessageWithX509Certificate

setSignMessageWithX509Certificate

getSoapNamespace

setSoapNamespace

getUrlToPublishTo

setUrlToPublishTo

getUserIds

setUserIds

getUseSoapInterface

setUseSoapInterface

equals

hashCode

toString