NotificationSettingsService (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

Service

All Known Subinterfaces:

NotificationSettingsServiceLocal
```
public interface NotificationSettingsService
extends Service
```
Service interface for Notification Settings operations

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`emailUnsubscribe(String key)`	Unsubscribes from emails with a key that was sent by email
`NotificationSettingsData`	`getData(UserLocatorVO locator)`	Returns the notification preferences for the given user / admin.
`EmailUnsubscribeData`	`getEmailUnsubscribeData(String key)`	Returns data for unsubscribing from emails with a key that was sent by email
`void`	`save(@NotNull NotificationSettingsDTO dto)`	Saves the notification settings for a given user / admin

- Method Detail
  - emailUnsubscribe
```
void emailUnsubscribe(String key)
               throws FrameworkException
```
    Unsubscribes from emails with a key that was sent by email
    
    Throws:
    
    FrameworkException
  - getData
```
NotificationSettingsData getData(UserLocatorVO locator)
                          throws FrameworkException
```
    Returns the notification preferences for the given user / admin. When null, returns the logged user's settings.
    
    Throws:
    
    FrameworkException
  - getEmailUnsubscribeData
```
EmailUnsubscribeData getEmailUnsubscribeData(String key)
                                      throws FrameworkException
```
    Returns data for unsubscribing from emails with a key that was sent by email
    
    Throws:
    
    FrameworkException
  - save
```
void save(@NotNull
          @NotNull NotificationSettingsDTO dto)
   throws FrameworkException
```
    Saves the notification settings for a given user / admin
    
    Throws:
    
    FrameworkException