EventNotification (com.docusign:docusign-esign-java 2.0.0 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-14T16:41:01.888-08:00")
public class EventNotification
extends Object

Constructor Summary

Constructors
Constructor and Description

EventNotification()

Constructors
Constructor and Description
`EventNotification()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`List<EnvelopeEvent>`	`getEnvelopeEvents()` The list of envelope-level events statuses that will trigger Connect to send updates to the url.
`String`	`getIncludeCertificateOfCompletion()` When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.
`String`	`getIncludeCertificateWithSoap()` When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml.
`String`	`getIncludeDocumentFields()` When set to true, the Document Fields associated with envelope documents are included in the data.
`String`	`getIncludeDocuments()` When set to true, the PDF documents are included in the message along with the updated XML.
`String`	`getIncludeEnvelopeVoidReason()` When set to true, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message.
`String`	`getIncludeSenderAccountAsCustomField()` When set to true, the sender account ID is included as a envelope custom field in the data.
`String`	`getIncludeTimeZone()` When set to true, the envelope time zone information is included in the message.
`String`	`getLoggingEnabled()` When set to true, logging is turned on for envelope events on the Web Console Connect page.
`List<RecipientEvent>`	`getRecipientEvents()` The list of recipient event statuses that will trigger Connect to send updates to the url.
`String`	`getRequireAcknowledgment()` When set to true, the DocuSign Connect service checks that the message was received and retries on failures.
`String`	`getSignMessageWithX509Cert()` When set to true, messages are signed with an X509 certificate.
`String`	`getSoapNameSpace()` This lists the namespace in the SOAP listener provided.
`String`	`getUrl()` The endpoint where envelope updates are sent.
`String`	`getUseSoapInterface()` When set to true, this tells the Connect service that the user�s endpoint has implemented a SOAP interface.
`int`	`hashCode()`
`void`	`setEnvelopeEvents(List<EnvelopeEvent> envelopeEvents)`
`void`	`setIncludeCertificateOfCompletion(String includeCertificateOfCompletion)`
`void`	`setIncludeCertificateWithSoap(String includeCertificateWithSoap)`
`void`	`setIncludeDocumentFields(String includeDocumentFields)`
`void`	`setIncludeDocuments(String includeDocuments)`
`void`	`setIncludeEnvelopeVoidReason(String includeEnvelopeVoidReason)`
`void`	`setIncludeSenderAccountAsCustomField(String includeSenderAccountAsCustomField)`
`void`	`setIncludeTimeZone(String includeTimeZone)`
`void`	`setLoggingEnabled(String loggingEnabled)`
`void`	`setRecipientEvents(List<RecipientEvent> recipientEvents)`
`void`	`setRequireAcknowledgment(String requireAcknowledgment)`
`void`	`setSignMessageWithX509Cert(String signMessageWithX509Cert)`
`void`	`setSoapNameSpace(String soapNameSpace)`
`void`	`setUrl(String url)`
`void`	`setUseSoapInterface(String useSoapInterface)`
`String`	`toString()`

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

- Constructor Detail
  - EventNotification
```
public EventNotification()
```
- Method Detail
  - getUrl
```
public String getUrl()
```
    The endpoint where envelope updates are sent. This will accept XML unless �useSoapInterface� is set to true.
  - setUrl
```
public void setUrl(String url)
```
  - getLoggingEnabled
```
public String getLoggingEnabled()
```
    When set to **true**, logging is turned on for envelope events on the Web Console Connect page.
  - setLoggingEnabled
```
public void setLoggingEnabled(String loggingEnabled)
```
  - getRequireAcknowledgment
```
public String getRequireAcknowledgment()
```
    When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures.
  - setRequireAcknowledgment
```
public void setRequireAcknowledgment(String requireAcknowledgment)
```
  - getEnvelopeEvents
```
public List<EnvelopeEvent> getEnvelopeEvents()
```
    The list of envelope-level events statuses that will trigger Connect to send updates to the url.
  - setEnvelopeEvents
```
public void setEnvelopeEvents(List<EnvelopeEvent> envelopeEvents)
```
  - getRecipientEvents
```
public List<RecipientEvent> getRecipientEvents()
```
    The list of recipient event statuses that will trigger Connect to send updates to the url.
  - setRecipientEvents
```
public void setRecipientEvents(List<RecipientEvent> recipientEvents)
```
  - getUseSoapInterface
```
public String getUseSoapInterface()
```
    When set to **true**, this tells the Connect service that the user�s endpoint has implemented a SOAP interface.
  - setUseSoapInterface
```
public void setUseSoapInterface(String useSoapInterface)
```
  - getSoapNameSpace
```
public String getSoapNameSpace()
```
    This lists the namespace in the SOAP listener provided.
  - setSoapNameSpace
```
public void setSoapNameSpace(String soapNameSpace)
```
  - getIncludeCertificateWithSoap
```
public String getIncludeCertificateWithSoap()
```
    When set to **true**, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken.
  - setIncludeCertificateWithSoap
```
public void setIncludeCertificateWithSoap(String includeCertificateWithSoap)
```
  - getSignMessageWithX509Cert
```
public String getSignMessageWithX509Cert()
```
    When set to **true**, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope.
  - setSignMessageWithX509Cert
```
public void setSignMessageWithX509Cert(String signMessageWithX509Cert)
```
  - getIncludeDocuments
```
public String getIncludeDocuments()
```
    When set to **true**, the PDF documents are included in the message along with the updated XML.
  - setIncludeDocuments
```
public void setIncludeDocuments(String includeDocuments)
```
  - getIncludeEnvelopeVoidReason
```
public String getIncludeEnvelopeVoidReason()
```
    When set to **true**, this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message.
  - setIncludeEnvelopeVoidReason
```
public void setIncludeEnvelopeVoidReason(String includeEnvelopeVoidReason)
```
  - getIncludeTimeZone
```
public String getIncludeTimeZone()
```
    When set to **true**, the envelope time zone information is included in the message.
  - setIncludeTimeZone
```
public void setIncludeTimeZone(String includeTimeZone)
```
  - getIncludeSenderAccountAsCustomField
```
public String getIncludeSenderAccountAsCustomField()
```
    When set to **true**, the sender account ID is included as a envelope custom field in the data.
  - setIncludeSenderAccountAsCustomField
```
public void setIncludeSenderAccountAsCustomField(String includeSenderAccountAsCustomField)
```
  - 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)
```
  - 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)
```
  - 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 EventNotification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventNotification

Method Detail

getUrl

setUrl

getLoggingEnabled

setLoggingEnabled

getRequireAcknowledgment

setRequireAcknowledgment

getEnvelopeEvents

setEnvelopeEvents

getRecipientEvents

setRecipientEvents

getUseSoapInterface

setUseSoapInterface

getSoapNameSpace

setSoapNameSpace

getIncludeCertificateWithSoap

setIncludeCertificateWithSoap

getSignMessageWithX509Cert

setSignMessageWithX509Cert

getIncludeDocuments

setIncludeDocuments

getIncludeEnvelopeVoidReason

setIncludeEnvelopeVoidReason

getIncludeTimeZone

setIncludeTimeZone

getIncludeSenderAccountAsCustomField

setIncludeSenderAccountAsCustomField

getIncludeDocumentFields

setIncludeDocumentFields

getIncludeCertificateOfCompletion

setIncludeCertificateOfCompletion

equals

hashCode

toString