Wenn Mitglieder mit Communities-Funktionen interagieren, werden OSGi-Ereignisse gesendet, die asynchrone Listener wie Benachrichtigungen oder Gamification (Scoring und Badging) in Trigger setzen können.
Die SocialEvent -Instanz einer Komponente zeichnet die Ereignisse als actions
auf, die für topic
auftreten. Das SocialEvent enthält eine Methode, mit der eine mit der Aktion verknüpfte verb
zurückgegeben wird. Es gibt eine n-1-Beziehung zwischen actions
und verbs
.
Die folgenden Tabellen beschreiben für die in der Version bereitgestellten Communities-Komponenten die verbs
, die für die einzelnen topic
verfügbaren Komponenten definiert sind.
Calendar
ComponentSocialEvent topic
= com/adobe/cq/social/calendar
Verb | Beschreibung |
---|---|
POST | Mitglied erstellt ein Kalenderereignis |
HINZUFÜGEN | Bemerkungen von Mitgliedern zu Kalenderereignissen |
UPDATE | Kalenderereignis oder -kommentar eines Mitglieds wird bearbeitet |
DELETE | Kalenderereignis oder Kommentar eines Mitglieds wird gelöscht |
Kommentare
ComponentSocialEvent topic
= com/adobe/cq/social/comment
Verb | Beschreibung |
---|---|
POST | Mitglied erstellt Kommentar |
HINZUFÜGEN | Antwort des Mitglieds auf Stellungnahme |
AKTUALISIEREN | Kommentar des Mitglieds wird bearbeitet |
DELETE | Anmerkung des Mitglieds wird gestrichen |
File Library
ComponentSocialEvent topic
= com/adobe/cq/social/fileLibrary
Verb | Beschreibung |
---|---|
POST | Mitglied erstellt Ordner |
ANHÄNGEN | Mitglied lädt eine Datei hoch |
AKTUALISIEREN | Mitglied aktualisiert Ordner oder Dateien |
DELETE | Mitglied löscht Ordner oder Dateien |
Forum
ComponentSocialEvent topic
= com/adobe/cq/social/forum
Verb | Beschreibung |
---|---|
POST | Mitglieder erstellen Forumthema |
HINZUFÜGEN | Antworten von Mitgliedern auf Forumthema |
AKTUALISIEREN | Forenthema oder Antwort eines Mitglieds wird bearbeitet |
DELETE | Forenthema oder Antwort eines Mitglieds wird gelöscht |
Journal
ComponentSocialEvent topic
= com/adobe/cq/social/journal
Verb | Beschreibung |
---|---|
POST | Mitglied erstellt einen Blog-Artikel |
HINZUFÜGEN | Kommentare von Mitgliedern zu Blogartikeln |
AKTUALISIEREN | Blogartikel oder Kommentar eines Mitglieds wird bearbeitet |
DELETE | Blogartikel oder Kommentar eines Mitglieds wird gelöscht |
QnA
ComponentSocialEvent topic
= com/adobe/cq/social/qna
Verb | Beschreibung |
---|---|
POST | Mitglied erstellt eine Frage zur Fragen-und-Antworten-Frage |
HINZUFÜGEN | Mitglied erstellt eine Antwort auf Fragen und Antworten |
AKTUALISIEREN | Frage oder Antwort des Mitglieds wird bearbeitet |
SELECT | Antwort des Mitglieds wird ausgewählt |
UNSELECT | Die Antwort des Mitglieds ist deaktiviert. |
DELETE | Frage oder Antwort des Mitglieds wird gestrichen |
Reviews
ComponentSocialEvent topic
= com/adobe/cq/social/review
Verb | Beschreibung |
---|---|
POST | Mitglied erstellt Überprüfung |
AKTUALISIEREN | Überprüfung durch Mitglieder wird bearbeitet |
DELETE | Überprüfung durch das Mitglied wird gestrichen |
Bewertung
ComponentSocialEvent topic
= com/adobe/cq/social/tally
Verb | Beschreibung |
---|---|
RATE HINZUFÜGEN | Der Inhalt des Mitglieds wurde bewertet |
RATE ENTFERNEN | Der Inhalt des Mitglieds wurde mit einer |
Voting
ComponentSocialEvent topic
= com/adobe/cq/social/tally
Verb | Beschreibung |
---|---|
ABSTIMMUNG HINZUFÜGEN | Der Inhalt des Mitglieds wurde abgestimmt |
ABSTIMMUNG ENTFERNEN | Über den Inhalt des Mitglieds wurde abgestimmt |
Moderationsfähige
KomponentenSocialEvent topic
= com/adobe/cq/social/moderation
Verb | Beschreibung |
---|---|
DENY | Inhalt des Mitglieds wird abgelehnt |
FLAG-AS-INAPPROPRIATE | Inhalt des Mitglieds ist gekennzeichnet |
UNFLAG-AS-INAPPROPRIATE | Inhalt des Mitglieds ist unmarkiert |
AKZEPT | Inhalt des Mitglieds wird vom Moderator genehmigt |
SCHLIESSEN | Mitglied schließt Kommentar zu Bearbeitungen und Antworten |
ÖFFNEN | Mitglied öffnet erneut Kommentar |
Bei einer benutzerdefinierten Komponente muss die abstrakte SocialEvent-Klasse erweitert werden, um die Ereignisse der Komponente als actions
aufzuzeichnen, die für ein topic
auftreten.
Das benutzerdefinierte Ereignis überschreibt die Methode getVerb()
, sodass für jedes action
ein entsprechendes verb
zurückgegeben wird. Das für eine Aktion zurückgegebene verb
kann eine häufig verwendete (z. B. POST
) oder für die Komponente spezialisierte (z. B. ADD RATING
) sein. Es gibt eine n-1-Beziehung zwischen actions
und verbs
.
Stellen Sie sicher, dass eine benutzerdefinierte Erweiterung mit einem niedrigeren Rang registriert ist als jede vorhandene Implementierung im Produkt.
org.osgi.service.event.Event;
com.adobe.cq.social.scf.core.SocialEvent;
com.adobe.granite.activitystreams.ObjectTypes;
com.adobe.granite.activitystreams.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");
}
}
}
}
Es ist möglich, Ereignisse zu überwachen, um zu ändern, was im Aktivitäts-Stream angezeigt wird.
Im folgenden Pseudo-Codebeispiel werden DELETE-Ereignisse für Kommentar-Komponenten aus dem Aktivitäts-Stream entfernt.
Erfordert das neueste 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[]{"*"};
}
}