EventNotification (docusign-esign-java 2.21.0-RC1 API)

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

```
public class EventNotification
extends Object
```
This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from \"Sent\" to \"Delivered\", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender.

Constructor Summary

Constructors
Constructor and Description

EventNotification()

Constructors
Constructor and Description
`EventNotification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventNotification`	`addEnvelopeEventsItem(EnvelopeEvent envelopeEventsItem)`
`EventNotification`	`addRecipientEventsItem(RecipientEvent recipientEventsItem)`
`EventNotification`	`envelopeEvents(List<EnvelopeEvent> envelopeEvents)`
`boolean`	`equals(Object o)`
`List<EnvelopeEvent>`	`getEnvelopeEvents()` A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.
`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`	`getIncludeHMAC()`
`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()` A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property.
`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()` Specifies the endpoint to which 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()`
`EventNotification`	`includeCertificateOfCompletion(String includeCertificateOfCompletion)`
`EventNotification`	`includeCertificateWithSoap(String includeCertificateWithSoap)`
`EventNotification`	`includeDocumentFields(String includeDocumentFields)`
`EventNotification`	`includeDocuments(String includeDocuments)`
`EventNotification`	`includeEnvelopeVoidReason(String includeEnvelopeVoidReason)`
`EventNotification`	`includeHMAC(String includeHMAC)`
`EventNotification`	`includeSenderAccountAsCustomField(String includeSenderAccountAsCustomField)`
`EventNotification`	`includeTimeZone(String includeTimeZone)`
`EventNotification`	`loggingEnabled(String loggingEnabled)`
`EventNotification`	`recipientEvents(List<RecipientEvent> recipientEvents)`
`EventNotification`	`requireAcknowledgment(String requireAcknowledgment)`
`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`	`setIncludeHMAC(String includeHMAC)`
`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)`
`EventNotification`	`signMessageWithX509Cert(String signMessageWithX509Cert)`
`EventNotification`	`soapNameSpace(String soapNameSpace)`
`String`	`toString()`
`EventNotification`	`url(String url)`
`EventNotification`	`useSoapInterface(String useSoapInterface)`

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

- Constructor Detail
  - EventNotification
```
public EventNotification()
```
- Method Detail
  - envelopeEvents
```
public EventNotification envelopeEvents(List<EnvelopeEvent> envelopeEvents)
```
  - addEnvelopeEventsItem
```
public EventNotification addEnvelopeEventsItem(EnvelopeEvent envelopeEventsItem)
```
  - getEnvelopeEvents
```
public List<EnvelopeEvent> getEnvelopeEvents()
```
    A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
    
    Returns:
    
    envelopeEvents
  - setEnvelopeEvents
```
public void setEnvelopeEvents(List<EnvelopeEvent> envelopeEvents)
```
  - includeCertificateOfCompletion
```
public EventNotification 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)
```
  - includeCertificateWithSoap
```
public EventNotification includeCertificateWithSoap(String includeCertificateWithSoap)
```
  - 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.
    
    Returns:
    
    includeCertificateWithSoap
  - setIncludeCertificateWithSoap
```
public void setIncludeCertificateWithSoap(String includeCertificateWithSoap)
```
  - includeDocumentFields
```
public EventNotification 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 EventNotification includeDocuments(String includeDocuments)
```
  - getIncludeDocuments
```
public String getIncludeDocuments()
```
    When set to **true**, the PDF documents are included in the message along with the updated XML.
    
    Returns:
    
    includeDocuments
  - setIncludeDocuments
```
public void setIncludeDocuments(String includeDocuments)
```
  - includeEnvelopeVoidReason
```
public EventNotification includeEnvelopeVoidReason(String includeEnvelopeVoidReason)
```
  - 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.
    
    Returns:
    
    includeEnvelopeVoidReason
  - setIncludeEnvelopeVoidReason
```
public void setIncludeEnvelopeVoidReason(String includeEnvelopeVoidReason)
```
  - includeHMAC
```
public EventNotification includeHMAC(String includeHMAC)
```
  - getIncludeHMAC
```
public String getIncludeHMAC()
```
    Returns:
    
    includeHMAC
  - setIncludeHMAC
```
public void setIncludeHMAC(String includeHMAC)
```
  - includeSenderAccountAsCustomField
```
public EventNotification includeSenderAccountAsCustomField(String includeSenderAccountAsCustomField)
```
  - getIncludeSenderAccountAsCustomField
```
public String getIncludeSenderAccountAsCustomField()
```
    When set to **true**, the sender account ID is included as a envelope custom field in the data.
    
    Returns:
    
    includeSenderAccountAsCustomField
  - setIncludeSenderAccountAsCustomField
```
public void setIncludeSenderAccountAsCustomField(String includeSenderAccountAsCustomField)
```
  - includeTimeZone
```
public EventNotification includeTimeZone(String includeTimeZone)
```
  - getIncludeTimeZone
```
public String getIncludeTimeZone()
```
    When set to **true**, the envelope time zone information is included in the message.
    
    Returns:
    
    includeTimeZone
  - setIncludeTimeZone
```
public void setIncludeTimeZone(String includeTimeZone)
```
  - loggingEnabled
```
public EventNotification loggingEnabled(String loggingEnabled)
```
  - getLoggingEnabled
```
public String getLoggingEnabled()
```
    When set to **true**, logging is turned on for envelope events on the Web Console Connect page.
    
    Returns:
    
    loggingEnabled
  - setLoggingEnabled
```
public void setLoggingEnabled(String loggingEnabled)
```
  - recipientEvents
```
public EventNotification recipientEvents(List<RecipientEvent> recipientEvents)
```
  - addRecipientEventsItem
```
public EventNotification addRecipientEventsItem(RecipientEvent recipientEventsItem)
```
  - getRecipientEvents
```
public List<RecipientEvent> getRecipientEvents()
```
    A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
    
    Returns:
    
    recipientEvents
  - setRecipientEvents
```
public void setRecipientEvents(List<RecipientEvent> recipientEvents)
```
  - requireAcknowledgment
```
public EventNotification requireAcknowledgment(String requireAcknowledgment)
```
  - getRequireAcknowledgment
```
public String getRequireAcknowledgment()
```
    When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures.
    
    Returns:
    
    requireAcknowledgment
  - setRequireAcknowledgment
```
public void setRequireAcknowledgment(String requireAcknowledgment)
```
  - signMessageWithX509Cert
```
public EventNotification signMessageWithX509Cert(String signMessageWithX509Cert)
```
  - 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.
    
    Returns:
    
    signMessageWithX509Cert
  - setSignMessageWithX509Cert
```
public void setSignMessageWithX509Cert(String signMessageWithX509Cert)
```
  - soapNameSpace
```
public EventNotification soapNameSpace(String soapNameSpace)
```
  - getSoapNameSpace
```
public String getSoapNameSpace()
```
    This lists the namespace in the SOAP listener provided.
    
    Returns:
    
    soapNameSpace
  - setSoapNameSpace
```
public void setSoapNameSpace(String soapNameSpace)
```
  - url
```
public EventNotification url(String url)
```
  - getUrl
```
public String getUrl()
```
    Specifies the endpoint to which envelope updates are sent. Udpates are sent as XML unless `useSoapInterface` property is set to **true**.
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
  - useSoapInterface
```
public EventNotification useSoapInterface(String useSoapInterface)
```
  - getUseSoapInterface
```
public String getUseSoapInterface()
```
    When set to **true**, this tells the Connect service that the user's endpoint has implemented a SOAP interface.
    
    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

Class EventNotification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventNotification

Method Detail

envelopeEvents

addEnvelopeEventsItem

getEnvelopeEvents

setEnvelopeEvents

includeCertificateOfCompletion

getIncludeCertificateOfCompletion

setIncludeCertificateOfCompletion

includeCertificateWithSoap

getIncludeCertificateWithSoap

setIncludeCertificateWithSoap

includeDocumentFields

getIncludeDocumentFields

setIncludeDocumentFields

includeDocuments

getIncludeDocuments

setIncludeDocuments

includeEnvelopeVoidReason

getIncludeEnvelopeVoidReason

setIncludeEnvelopeVoidReason

includeHMAC

getIncludeHMAC

setIncludeHMAC

includeSenderAccountAsCustomField

getIncludeSenderAccountAsCustomField

setIncludeSenderAccountAsCustomField

includeTimeZone

getIncludeTimeZone

setIncludeTimeZone

loggingEnabled

getLoggingEnabled

setLoggingEnabled

recipientEvents

addRecipientEventsItem

getRecipientEvents

setRecipientEvents

requireAcknowledgment

getRequireAcknowledgment

setRequireAcknowledgment

signMessageWithX509Cert

getSignMessageWithX509Cert

setSignMessageWithX509Cert

soapNameSpace

getSoapNameSpace

setSoapNameSpace

url

getUrl

setUrl

useSoapInterface

getUseSoapInterface

setUseSoapInterface

equals

hashCode

toString