Class NotificationAudience

java.lang.Object

com.kingsrook.qqq.backend.core.alerts.NotificationAudience

All Implemented Interfaces:

Serializable

public final class NotificationAudience
extends Object
implements Serializable

Who a user notification is for. Construct these with the static factories; an alerts implementation resolves them to user ids when it sends: - ALL_USERS: every active user. - ROLES: users with any of the named roles (values are role names). - PERMISSION: users holding one permission (values has one entry). - USERS: the named user ids, as given. Immutable. Null and blank values are dropped.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NotificationAudience.Type	The kinds of audience.

Method Summary

Modifier and Type	Method	Description
static NotificationAudience	allUsers()	Every active user.
boolean	equals(Object o)
NotificationAudience.Type	getType()	Getter for type
List<String>	getValues()	Getter for values (unmodifiable; empty for ALL_USERS)
int	hashCode()
static NotificationAudience	permission(String permissionName)	Users holding the named permission.
static NotificationAudience	roles(String... roleNames)	Users with any of the named roles.
String	toString()
static NotificationAudience	user(String userId)	One user.
static NotificationAudience	users(String... userIds)	The named user ids.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

allUsers

public static NotificationAudience allUsers()

Every active user.

roles

public static NotificationAudience roles(String... roleNames)

Users with any of the named roles.

permission

public static NotificationAudience permission(String permissionName)

Users holding the named permission.

users

public static NotificationAudience users(String... userIds)

The named user ids.

user

public static NotificationAudience user(String userId)

One user.

getType

public NotificationAudience.Type getType()

Getter for type

getValues

public List<String> getValues()

Getter for values (unmodifiable; empty for ALL_USERS)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object