ReactionableObject (Ametys 4.5.x - API)

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Comment, Container, Course, CourseList, CoursePart, DefaultContent, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, SubProgram
```
public interface ReactionableObject
```
Interface to handle reactions on object

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class ReactionableObject.ReactionType
Reaction type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addReaction(UserIdentity user, ReactionableObject.ReactionType reactionType)`	Add the user reaction
`List<UserIdentity>`	`getReactionUsers(ReactionableObject.ReactionType reactionType)`	Get the list of users who react
`void`	`removeReaction(UserIdentity user, ReactionableObject.ReactionType reactionType)`	Remove the user reaction

Method Detail

addReaction

void addReaction(UserIdentity user,
                 ReactionableObject.ReactionType reactionType)

Add the user reaction

Parameters:: user - the user; reactionType - the reaction type

removeReaction

void removeReaction(UserIdentity user,
                    ReactionableObject.ReactionType reactionType)

Remove the user reaction

Parameters:: user - the user; reactionType - the reaction type

getReactionUsers
```
List<UserIdentity> getReactionUsers(ReactionableObject.ReactionType reactionType)
```
Get the list of users who react

Parameters:

reactionType - the reaction type

Returns:

the list of users