public final class Favorites extends Object
Modifier and Type | Class and Description |
---|---|
static class |
Favorites.FavoriteException
Exception for Favorite operations
|
Constructor and Description |
---|
Favorites() |
Modifier and Type | Method and Description |
---|---|
static void |
addFavorite(hudson.model.User user,
hudson.model.Item item)
Add an item as a favorite for a user
Fires
FavoriteListener.fireOnAddFavourite(Item, User) |
static Iterable<hudson.model.Item> |
getFavorites(hudson.model.User user)
Get all items that the provided user has favorited
|
static boolean |
hasFavorite(hudson.model.User user,
hudson.model.Item item)
Check if the item has a favorite entry regardless of its state
This is useful for checking if a favorite/unfavorite operation has ever been performed against this user
|
static boolean |
isFavorite(hudson.model.User user,
hudson.model.Item item)
Check if the item is favorited
|
static void |
removeFavorite(hudson.model.User user,
hudson.model.Item item)
Remove an item as a favorite for a user
Fires
FavoriteListener.fireOnRemoveFavourite(Item, User) |
static boolean |
toggleFavorite(hudson.model.User user,
hudson.model.Item item)
Toggles the favorite for a job
|
public static boolean toggleFavorite(@Nonnull hudson.model.User user, @Nonnull hudson.model.Item item) throws Favorites.FavoriteException
user
- that the favorite belongs toitem
- to favoriteFavorites.FavoriteException
public static boolean isFavorite(@Nonnull hudson.model.User user, @Nonnull hudson.model.Item item)
user
- to checkitem
- to checkpublic static boolean hasFavorite(@Nonnull hudson.model.User user, @Nonnull hudson.model.Item item) throws Favorites.FavoriteException
user
- to checkitem
- to checkFavorites.FavoriteException
public static void addFavorite(@Nonnull hudson.model.User user, @Nonnull hudson.model.Item item) throws Favorites.FavoriteException
FavoriteListener.fireOnAddFavourite(Item, User)
user
- to add the favorite toitem
- to favoriteFavorites.FavoriteException
public static void removeFavorite(@Nonnull hudson.model.User user, @Nonnull hudson.model.Item item) throws Favorites.FavoriteException
FavoriteListener.fireOnRemoveFavourite(Item, User)
user
- to remove the favorite fromitem
- to favoriteFavorites.FavoriteException
Copyright © 2016. All rights reserved.