EventNotification (docusign-esign-java 2.0.2 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-07-18T18:11:15.675-07:00")
public class EventNotification
extends Object

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`	`envelopeEvents(List<EnvelopeEvent> envelopeEvents)` A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.
`boolean`	`equals(Object o)`
`List<EnvelopeEvent>`	`getEnvelopeEvents()`
`String`	`getIncludeCertificateOfCompletion()`
`String`	`getIncludeCertificateWithSoap()`
`String`	`getIncludeDocumentFields()`
`String`	`getIncludeDocuments()`
`String`	`getIncludeEnvelopeVoidReason()`
`String`	`getIncludeSenderAccountAsCustomField()`
`String`	`getIncludeTimeZone()`
`String`	`getLoggingEnabled()`
`List<RecipientEvent>`	`getRecipientEvents()`
`String`	`getRequireAcknowledgment()`
`String`	`getSignMessageWithX509Cert()`
`String`	`getSoapNameSpace()`
`String`	`getUrl()`
`String`	`getUseSoapInterface()`
`int`	`hashCode()`
`EventNotification`	`includeCertificateOfCompletion(String includeCertificateOfCompletion)` When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.
`EventNotification`	`includeCertificateWithSoap(String includeCertificateWithSoap)` When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml.
`EventNotification`	`includeDocumentFields(String includeDocumentFields)` When set to true, the Document Fields associated with envelope documents are included in the data.
`EventNotification`	`includeDocuments(String includeDocuments)` When set to true, the PDF documents are included in the message along with the updated XML.
`EventNotification`	`includeEnvelopeVoidReason(String includeEnvelopeVoidReason)` 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.
`EventNotification`	`includeSenderAccountAsCustomField(String includeSenderAccountAsCustomField)` When set to true, the sender account ID is included as a envelope custom field in the data.
`EventNotification`	`includeTimeZone(String includeTimeZone)` When set to true, the envelope time zone information is included in the message.
`EventNotification`	`loggingEnabled(String loggingEnabled)` When set to true, logging is turned on for envelope events on the Web Console Connect page.
`EventNotification`	`recipientEvents(List<RecipientEvent> recipientEvents)` A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the url property.\n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node.
`EventNotification`	`requireAcknowledgment(String requireAcknowledgment)` When set to true, the DocuSign Connect service checks that the message was received and retries on failures.
`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)`
`EventNotification`	`signMessageWithX509Cert(String signMessageWithX509Cert)` When set to true, messages are signed with an X509 certificate.
`EventNotification`	`soapNameSpace(String soapNameSpace)` This lists the namespace in the SOAP listener provided.
`String`	`toString()`
`EventNotification`	`url(String url)` Specifies the endpoint to which envelope updates are sent.
`EventNotification`	`useSoapInterface(String useSoapInterface)` When set to true, this tells the Connect service that the user's endpoint has implemented a SOAP interface.

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

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

url

getUrl

setUrl

loggingEnabled

getLoggingEnabled

setLoggingEnabled

requireAcknowledgment

getRequireAcknowledgment

setRequireAcknowledgment

envelopeEvents

getEnvelopeEvents

setEnvelopeEvents

recipientEvents

getRecipientEvents

setRecipientEvents

useSoapInterface

getUseSoapInterface

setUseSoapInterface

soapNameSpace

getSoapNameSpace

setSoapNameSpace

includeCertificateWithSoap

getIncludeCertificateWithSoap

setIncludeCertificateWithSoap

signMessageWithX509Cert

getSignMessageWithX509Cert

setSignMessageWithX509Cert

includeDocuments

getIncludeDocuments

setIncludeDocuments

includeEnvelopeVoidReason

getIncludeEnvelopeVoidReason

setIncludeEnvelopeVoidReason

includeTimeZone

getIncludeTimeZone

setIncludeTimeZone

includeSenderAccountAsCustomField

getIncludeSenderAccountAsCustomField

setIncludeSenderAccountAsCustomField

includeDocumentFields

getIncludeDocumentFields

setIncludeDocumentFields

includeCertificateOfCompletion

getIncludeCertificateOfCompletion

setIncludeCertificateOfCompletion

equals

hashCode

toString