Lorsque les membres interagissent avec les fonctionnalités des communautés, des événements OSGi sont envoyés, ce qui peut déclencher des écouteurs asynchrones, tels que des notifications ou une gamification (score et badge).
L’instance SocialEvent d’un composant enregistre les événements sous la forme actions
qui se produisent pour une topic
. SocialEvent inclut une méthode pour renvoyer une verb
associée à l’action. Il existe une relation n-1 entre actions
et verbs
.
Pour les composants Communities fournis dans la version, les tableaux suivants décrivent le verbs
défini pour chaque topic
disponible à utiliser.
Calendrier
ComponentSocialEvent topic
= com/adobe/cq/social/calendar
Verbe | Description |
---|---|
POST | Un membre crée un événement de calendrier |
AJOUTER | Commentaires des membres sur un événement de calendrier |
UPDATE | Le événement de calendrier ou le commentaire du membre est modifié |
DELETE | Le événement de calendrier ou le commentaire du membre est supprimé |
Commentaires
ComponentSocialEvent topic
= com/adobe/cq/social/comment
Verbe | Description |
---|---|
POST | Un membre crée un commentaire |
AJOUTER | Réponses du membre au commentaire |
METTRE À JOUR | Le commentaire du membre est modifié. |
DELETE | Le commentaire du membre est supprimé |
File Library
ComponentSocialEvent topic
= com/adobe/cq/social/fileLibrary
Verbe | Description |
---|---|
POST | Un membre crée un dossier |
ATTAQUE | Le membre télécharge un fichier |
METTRE À JOUR | Le membre met à jour un dossier ou un fichier |
DELETE | Le membre supprime un dossier ou un fichier |
Forum
ComponentSocialEvent topic
= com/adobe/cq/social/forum
Verbe | Description |
---|---|
POST | Le membre crée une rubrique de forum |
AJOUTER | Réponses des membres au sujet du forum |
METTRE À JOUR | Le sujet ou la réponse du membre sur le forum est modifié |
DELETE | Le sujet ou la réponse du membre sur le forum est supprimé |
Journal
ComponentSocialEvent topic
= com/adobe/cq/social/journal
Verbe | Description |
---|---|
POST | Un membre crée un article de blog |
AJOUTER | Commentaires d'un membre sur un article de blog |
METTRE À JOUR | L'article ou le commentaire du blog du membre est modifié |
DELETE | L'article ou le commentaire du blog du membre est supprimé |
QnA
ComponentSocialEvent topic
= com/adobe/cq/social/qna
Verbe | Description |
---|---|
POST | Un membre crée une question QnA |
AJOUTER | Un membre crée une réponse QnA |
METTRE À JOUR | Question ou réponse QnA du membre modifiée |
SELECT | La réponse du membre est sélectionnée |
DÉSÉLECTIONNER | La réponse du membre est désélectionnée |
DELETE | Question ou réponse QnA du membre supprimée |
Critiques
ComponentSocialEvent topic
= com/adobe/cq/social/review
Verbe | Description |
---|---|
POST | Le membre crée une révision |
METTRE À JOUR | La révision du membre est modifiée. |
DELETE | La révision du membre est supprimée |
Évaluation de
ComponentSocialEvent topic
= com/adobe/cq/social/tally
Verbe | Description |
---|---|
AJOUTE | Le contenu du membre a été amélioré |
SUPPRESSION DE LA COTE | Le contenu du membre a été abaissé |
Vote du
composantSocialEvent topic
= com/adobe/cq/social/tally
Verbe | Description |
---|---|
AJOUTER VOTE | Le contenu du membre a été voté |
SUPPRIMER LE VOTE | Le contenu du membre a été rejeté |
Composants prenant en charge la modérationSocialEvent topic
= com/adobe/cq/social/modération
Verbe | Description |
---|---|
DENY | Le contenu du membre est refusé |
INDICATEUR INAPPROPRIÉ | Le contenu du membre est marqué |
INAPPROPRIÉ | Le contenu du membre n'est pas marqué |
ACCEPTER | Le contenu du membre est approuvé par le modérateur |
CLOSE | Le membre ferme les commentaires aux modifications et aux réponses |
OUVRIR | Commentaire de réouverture du membre |
Pour un composant personnalisé, la classe abstraite SocialEvent doit être étendue d pour enregistrer les événements du composant comme actions
qui se produisent pour un topic
.
Le événement personnalisé remplacerait la méthode getVerb()
de sorte qu'un verb
approprié soit renvoyé pour chaque action
. L'élément verb
renvoyé pour une action peut être couramment utilisé (tel que POST
) ou spécialisé pour le composant (tel que ADD RATING
). Il existe une relation n-1 entre actions
et verbs
.
Assurez-vous qu’une extension personnalisée est enregistrée avec un classement inférieur à toute implémentation existante dans le produit.
org.osgi.service.événement.Événement;
com.adobe.cq.social.scf.core.SocialEvent;
com.adobe.granite.activitystream.ObjectTypes;
com.adobe.granite.activitystream.Verbs;
package com.mycompany.recipe;
import org.osgi.service.event.Event;
import com.adobe.cq.social.scf.core.SocialEvent;
import com.adobe.granite.activitystreams.ObjectTypes;
import com.adobe.granite.activitystreams.Verbs;
/*
* The Recipe type, passed to RecipeEvent(), would be a custom Recipe class
* that extends either
* com.adobe.cq.social.scf.SocialComponent
* or
* com.adobe.cq.social.scf.SocialCollectionComponent
* See https://docs.adobe.com/docs/en/aem/6-2/develop/communities/scf/server-customize.html
*/
/**
* Defines events that are triggered on a custom component, "Recipe".
*/
public class RecipeEvent extends SocialEvent<RecipeEvent.RecipeActions> {
private static final long serialVersionUID = 1L;
protected static final String PARENT_PATH = "PARENT_PATH";
/**
* The event topic suffix for Recipe events
*/
public static final String RECIPE_TOPIC = "recipe";
/**
* @param recipe - the recipe resource on which the event was triggered
* @param userId - the user id of the user who triggered the action
* @param action - the recipe action that triggered this event
*/
public RecipeEvent(final Recipe recipe, final String userId, final RecipeEvent.RecipeActions action) {
String recipePath = recipe.getResource().getPath();
String parentPath = (recipe.getParentComponent() != null) ?
recipe.getParentComponent().getResource().getPath() :
recipe.getSourceComponentId();
this(recipePath, userId, parentPath, action);
}
/**
* @param recipePath - the path to the recipe resource (jcr node) on which the event was triggered
* @param userId - the user id of the user who triggered the action
* @param parentPath - the path to the parent node of the recipe resource
* @param action - the recipe action that triggered this event
*/
public RecipeEvent(final String recipePath, final String userId, final String parentPath) {
super(RECIPE_TOPIC, recipePath, userId, action,
new BaseEventObject(recipePath, ObjectTypes.ARTICLE),
new BaseEventObject(parentPath, ObjectTypes.COLLECTION),
new HashMap<String, Object>(1) {
private static final long serialVersionUID = 1L;
{
if (parentPath != null) {
this.put(PARENT_PATH, parentPath);
}
}
});
}
private RecipeEvent (final Event event) {
super(event);
}
/**
* List of available recipe actions that can trigger a recipe event.
*/
public static enum RecipeActions implements SocialEvent.SocialActions {
RecipeAdded,
RecipeModified,
RecipeDeleted;
@Override
public String getVerb() {
switch (this) {
case RecipeAdded:
return Verbs.POST;
case RecipeModified:
return Verbs.UPDATE;
case RecipeDeleted:
return Verbs.DELETE;
default:
throw new IllegalArgumentException("Unsupported action");
}
}
}
}
Il est possible d'écouter les événements dans le but de modifier ce qui apparaît dans le flux d'activité.
L'exemple de pseudo-code suivant supprime les événements DELETE pour le composant Commentaires du flux d'activité.
Nécessite dernier Feature Pack.
package my.company.comments;
import java.util.Collections;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Modified;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.osgi.PropertiesUtil;
import org.osgi.service.component.ComponentContext;
import com.adobe.cq.social.activitystreams.listener.api.ActivityStreamProviderExtension;
import com.adobe.cq.social.commons.events.CommentEvent.CommentActions;
import com.adobe.cq.social.scf.core.SocialEvent;
@Service
@Component(metatype = true, label = "My Comment Delete Event Filter",
description = "Prevents comment DELETE events from showing up in activity streams")
public class CommentDeleteEventActivityFilter implements ActivityStreamProviderExtension {
@Property(name = "ranking", intValue = 10)
protected int ranking;
@Activate
public void activate(final ComponentContext ctx) {
ranking = PropertiesUtil.toInteger(ctx.getProperties().get("ranking"), 10);
}
@Modified
public void update(final Map<String, Object> props) {
ranking = PropertiesUtil.toInteger(props.get("ranking"), 10);
}
@Override
public boolean evaluate(final SocialEvent<?> evt, final Resource resource) {
if (evt.getAction() != null && evt.getAction() instanceof SocialEvent.SocialActions) {
final SocialEvent.SocialActions action = evt.getAction();
if (StringUtils.equals(action.getVerb(), CommentActions.DELETED.getVerb())) {
return false;
}
}
return true;
}
@Override
public Map<String, ? extends Object> getActivityProperties(final SocialEvent<?> arg0, final Resource arg1) {
return Collections.<String, Object>emptyMap();
}
@Override
public Map<String, ? extends Object> getActorProperties(final SocialEvent<?> arg0, final Resource arg1) {
return Collections.<String, Object>emptyMap();
}
@Override
public String getName() {
return "My Comment Delete Event Filter";
}
@Override
public Map<String, ? extends Object> getObjectProperties(final SocialEvent<?> arg0, final Resource arg1) {
return Collections.<String, Object>emptyMap();
}
/* Ensure a custom extension is registered with a ranking lower than any existing implementation in the product. */
@Override
public int getRanking() {
return this.ranking;
}
@Override
public Map<String, ? extends Object> getTargetProperties(final SocialEvent<?> arg0, final Resource arg1) {
return Collections.<String, Object>emptyMap();
}
@Override
public String[] getStreamProviderPid() {
return new String[]{"*"};
}
}