org.sakaiproject.pasystem.api

Interface Banners

All Superinterfaces:

Acknowledger

public interface Banners
extends Acknowledger

The interface for the banners sub-service.

Method Summary

Modifier and Type	Method and Description
void	clearTemporaryDismissedForUser(String userId) Forget all acknowledgements for the current user.
String	createBanner(Banner banner)
void	deleteBanner(String uuid)
List<Banner>	getAll()
Optional<Banner>	getForId(String uuid)
List<Banner>	getRelevantBanners(String serverId, String userId) A list of banners that should be shown for a given server and user.
void	updateBanner(Banner banner)

Methods inherited from interface org.sakaiproject.pasystem.api.Acknowledger

acknowledge, acknowledge

Method Detail

getRelevantBanners

List<Banner> getRelevantBanners(String serverId,
                                String userId)

A list of banners that should be shown for a given server and user.

createBanner

String createBanner(Banner banner)

updateBanner

void updateBanner(Banner banner)

deleteBanner

void deleteBanner(String uuid)

getAll

List<Banner> getAll()

clearTemporaryDismissedForUser

void clearTemporaryDismissedForUser(String userId)

Forget all acknowledgements for the current user.

getForId

Optional<Banner> getForId(String uuid)