PushNotificationHandler (Cyclos 4.14.14 Scripting API Documentation)

All Known Implementing Classes:

AbstractPushNotificationHandlerImpl, NoClusterPushNotificationHandlerImpl
```
public interface PushNotificationHandler
```
Handler for using push notifications

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close(String id)`	Closes a subscription.
`<T> boolean`	`publish(PushNotificationEventContext<T> context, Supplier<T> dataSupplier)`	Publishes a `PushNotificationEvent` to a specific user session, calling the supplier and returning if the event is really published
`String`	`subscribe(String clientId, String lastEventId, PushNotificationEventFilter filter, Consumer<PushNotificationEvent<?>> listener)`	Subscribes a new `PushNotificationListener` for listening events of the given types, for the user expressed in the current `SessionData`.
`void`	`timeout(String id)`	Marks a subscription as timed-out.

- Method Detail
  - close
```
void close(String id)
```
    Closes a subscription.
    
    See Also:
    
    ServiceFacade.closeSubscription(String)
  - publish
```
<T> boolean publish(PushNotificationEventContext<T> context,
                    Supplier<T> dataSupplier)
```
    Publishes a PushNotificationEvent to a specific user session, calling the supplier and returning if the event is really published
  - subscribe
```
String subscribe(String clientId,
                 String lastEventId,
                 PushNotificationEventFilter filter,
                 Consumer<PushNotificationEvent<?>> listener)
```
    Subscribes a new PushNotificationListener for listening events of the given types, for the user expressed in the current SessionData.
  - timeout
```
void timeout(String id)
```
    Marks a subscription as timed-out.
    
    See Also:
    
    ServiceFacade.timeoutSubscription(String)