net.croz.nrich.notification.api.service.NotificationResponseService Maven / Gradle / Ivy
/*
* Copyright 2020-2023 CROZ d.o.o, the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package net.croz.nrich.notification.api.service;
import net.croz.nrich.notification.api.model.AdditionalNotificationData;
import net.croz.nrich.notification.api.response.NotificationDataResponse;
import net.croz.nrich.notification.api.response.NotificationResponse;
public interface NotificationResponseService extends BaseNotificationResponseService {
/**
* Returns response with {@link net.croz.nrich.notification.api.model.Notification} instance.
*
* @param data data to include in response
* @param additionalNotificationData additional notification data to add to notification
* @param type of data
* @return response with notification
*/
NotificationDataResponse responseWithNotificationActionResolvedFromRequest(D data, AdditionalNotificationData additionalNotificationData);
/**
* Returns response with {@link net.croz.nrich.notification.api.model.Notification} instance.
*
* @param data data to include in response
* @param actionName name of the action for which to resolve notification
* @param additionalNotificationData additional notification data to add to notification
* @param type of data
* @return response with notification
*/
NotificationDataResponse responseWithNotification(D data, String actionName, AdditionalNotificationData additionalNotificationData);
default NotificationDataResponse responseWithNotificationActionResolvedFromRequest(D data) {
return responseWithNotificationActionResolvedFromRequest(data, AdditionalNotificationData.empty());
}
default NotificationDataResponse responseWithNotification(D data, String actionName) {
return responseWithNotification(data, actionName, AdditionalNotificationData.empty());
}
}