Package com.docusign.esign.model

Class 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 Detail

      • EventNotification

        public EventNotification()

    • Method Detail

      • deliveryMode

        public EventNotification deliveryMode​(String deliveryMode)
        deliveryMode.
        Returns:
        EventNotification

      • getDeliveryMode

        public String getDeliveryMode()
        .
        Returns:
        deliveryMode

      • setDeliveryMode

        public void setDeliveryMode​(String deliveryMode)
        setDeliveryMode.

      • addEnvelopeEventsItem

        public EventNotification addEnvelopeEventsItem​(EnvelopeEvent envelopeEventsItem)
        addEnvelopeEventsItem.
        Returns:
        EventNotification

      • 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)
        setEnvelopeEvents.

      • getEventData

        public ConnectEventData getEventData()
        Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications).
        Returns:
        eventData

      • setEventData

        public void setEventData​(ConnectEventData eventData)
        setEventData.

      • addEventsItem

        public EventNotification addEventsItem​(String eventsItem)
        addEventsItem.
        Returns:
        EventNotification

      • getEvents

        public List<String> getEvents()
        .
        Returns:
        events

      • setEvents

        public void setEvents​(List<String> events)
        setEvents.

      • includeCertificateOfCompletion

        public EventNotification includeCertificateOfCompletion​(String includeCertificateOfCompletion)
        includeCertificateOfCompletion.
        Returns:
        EventNotification

      • 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)
        setIncludeCertificateOfCompletion.

      • includeCertificateWithSoap

        public EventNotification includeCertificateWithSoap​(String includeCertificateWithSoap)
        includeCertificateWithSoap.
        Returns:
        EventNotification

      • 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)
        setIncludeCertificateWithSoap.

      • includeDocumentFields

        public EventNotification includeDocumentFields​(String includeDocumentFields)
        includeDocumentFields.
        Returns:
        EventNotification

      • 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)
        setIncludeDocumentFields.

      • includeDocuments

        public EventNotification includeDocuments​(String includeDocuments)
        includeDocuments.
        Returns:
        EventNotification

      • 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)
        setIncludeDocuments.

      • includeEnvelopeVoidReason

        public EventNotification includeEnvelopeVoidReason​(String includeEnvelopeVoidReason)
        includeEnvelopeVoidReason.
        Returns:
        EventNotification

      • 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)
        setIncludeEnvelopeVoidReason.

      • includeHMAC

        public EventNotification includeHMAC​(String includeHMAC)
        includeHMAC.
        Returns:
        EventNotification

      • getIncludeHMAC

        public String getIncludeHMAC()
        .
        Returns:
        includeHMAC

      • setIncludeHMAC

        public void setIncludeHMAC​(String includeHMAC)
        setIncludeHMAC.

      • includeSenderAccountAsCustomField

        public EventNotification includeSenderAccountAsCustomField​(String includeSenderAccountAsCustomField)
        includeSenderAccountAsCustomField.
        Returns:
        EventNotification

      • 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)
        setIncludeSenderAccountAsCustomField.

      • includeTimeZone

        public EventNotification includeTimeZone​(String includeTimeZone)
        includeTimeZone.
        Returns:
        EventNotification

      • 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)
        setIncludeTimeZone.

      • loggingEnabled

        public EventNotification loggingEnabled​(String loggingEnabled)
        loggingEnabled.
        Returns:
        EventNotification

      • 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)
        setLoggingEnabled.

      • addRecipientEventsItem

        public EventNotification addRecipientEventsItem​(RecipientEvent recipientEventsItem)
        addRecipientEventsItem.
        Returns:
        EventNotification

      • 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)
        setRecipientEvents.

      • requireAcknowledgment

        public EventNotification requireAcknowledgment​(String requireAcknowledgment)
        requireAcknowledgment.
        Returns:
        EventNotification

      • 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)
        setRequireAcknowledgment.

      • signMessageWithX509Cert

        public EventNotification signMessageWithX509Cert​(String signMessageWithX509Cert)
        signMessageWithX509Cert.
        Returns:
        EventNotification

      • 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)
        setSignMessageWithX509Cert.

      • soapNameSpace

        public EventNotification soapNameSpace​(String soapNameSpace)
        soapNameSpace.
        Returns:
        EventNotification

      • getSoapNameSpace

        public String getSoapNameSpace()
        This lists the namespace in the SOAP listener provided..
        Returns:
        soapNameSpace

      • setSoapNameSpace

        public void setSoapNameSpace​(String soapNameSpace)
        setSoapNameSpace.

      • 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)
        setUrl.

      • useSoapInterface

        public EventNotification useSoapInterface​(String useSoapInterface)
        useSoapInterface.
        Returns:
        EventNotification

      • 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)
        setUseSoapInterface.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object