com.silanis.esl.sdk.builder

Class EventNotificationConfigBuilder

java.lang.Object

com.silanis.esl.sdk.builder.EventNotificationConfigBuilder

public final class EventNotificationConfigBuilder
extends Object

The EventNotificationConfigBuilder class is used to build and configure event notifications.

Events and Event Notifications [eSignLive™ Documentation Project]

Method Summary

Modifier and Type	Method and Description
EventNotificationConfig	build() Builds the actual event notification config object
EventNotificationConfigBuilder	forEvent(NotificationEvent event) Adds an event to the current EventNotificationConfig event set
static EventNotificationConfigBuilder	newEventNotificationConfig(String url) Creates a new newEventNotificationConfigBuilder for the url specified as argument
EventNotificationConfigBuilder	setEvents(Set<NotificationEvent> events) Set events to the current EventNotificationConfig event set
EventNotificationConfigBuilder	withKey(String key) Adds a key to the current EventNotificationConfig.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newEventNotificationConfig

public static EventNotificationConfigBuilder newEventNotificationConfig(String url)

Creates a new newEventNotificationConfigBuilder for the url specified as argument

Parameters:

url - represents the endpoint to which e-SL will post HTTP based notifications

Returns:

a new newEventNotificationConfigBuilder instance

withKey

public EventNotificationConfigBuilder withKey(String key)

Adds a key to the current EventNotificationConfig.

Parameters:

key - callback auth key

Returns:

the event notification config builder itself

forEvent

public EventNotificationConfigBuilder forEvent(NotificationEvent event)

Adds an event to the current EventNotificationConfig event set

Parameters:

event - the new event

Returns:

the event notification config builder itself

setEvents

public EventNotificationConfigBuilder setEvents(Set<NotificationEvent> events)

Set events to the current EventNotificationConfig event set

Parameters:

events - the events

Returns:

the event notification config builder itself

build

public EventNotificationConfig build()

Builds the actual event notification config object

Returns:

the actual event notification config object