Interface SiteMessageService
- All Known Implementing Classes:
DefaultSiteMessageService
public interface SiteMessageService
Service to provide methods for site message
-
Method Summary
Modifier and TypeMethodDescriptioncreateMessage(String subject, String body, SiteMessageType type, ItemModel externalItem, NotificationType notificationType) Creates a site message by given subject, link, body, message type, notification type and localecreateMessage(String title, String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType, Locale locale) Deprecated, for removal: This API element is subject to removal in a future version.since 1905, replace with createMessage(String title, String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType)getPaginatedMessagesForCustomer(CustomerModel customer, SearchPageData searchPageData) Gets all paginated site messagesgetPaginatedMessagesForType(CustomerModel customer, SiteMessageType type, SearchPageData searchPageData) Gets paginated site messages for the given typegetSiteMessagesForCustomer(CustomerModel customer) Gets all site message of the customer
-
Method Details
-
getPaginatedMessagesForType
SearchPageData<SiteMessageForCustomerModel> getPaginatedMessagesForType(CustomerModel customer, SiteMessageType type, SearchPageData searchPageData) Gets paginated site messages for the given type- Parameters:
customer- the specific customertype- the given message typesearchPageData- pagination parameters- Returns:
- paginated result
-
getPaginatedMessagesForCustomer
SearchPageData<SiteMessageForCustomerModel> getPaginatedMessagesForCustomer(CustomerModel customer, SearchPageData searchPageData) Gets all paginated site messages- Parameters:
customer- the specific customersearchPageData- pagination parameters- Returns:
- paginated result
-
createMessage
@Deprecated(since="1905", forRemoval=true) SiteMessageModel createMessage(String title, String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType, Locale locale) Deprecated, for removal: This API element is subject to removal in a future version.since 1905, replace with createMessage(String title, String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType)Creates a site message by given title, link, content, message type, notification type and locale- Parameters:
title- the message titlecontent- the message contenttype- the message typeexternalItem- the related item modelnotificationType- the notification typelocale- the locale, if null, default current locale- Returns:
- the created message model
-
createMessage
SiteMessageModel createMessage(String subject, String body, SiteMessageType type, ItemModel externalItem, NotificationType notificationType) Creates a site message by given subject, link, body, message type, notification type and locale- Parameters:
subject- the message subjectbody- the message bodytype- the message typeexternalItem- the related item modelnotificationType- the notification type- Returns:
- the created message model
-
getSiteMessagesForCustomer
Gets all site message of the customer- Parameters:
customer- the specific customer- Returns:
- list of site message for customer
-