Componenti di OSGi Events for Communities osgi-events-for-communities-components

CAUTION
AEM 6.4 ha raggiunto la fine del supporto esteso e questa documentazione non viene più aggiornata. Per maggiori dettagli, consulta la nostra periodi di assistenza tecnica. Trova le versioni supportate qui.

Panoramica overview

Quando i membri interagiscono con le funzioni di Communities, vengono inviati eventi OSGi che possono attivare listener asincroni, come notifiche o gamification (punteggio e contrassegno).

Di un componente SocialEvent L’istanza registra gli eventi come actionsche si verificano per topic. SocialEvent include un metodo per restituire un verbassociato all’azione. C'è un n-1 rapporto tra actionse verbs.

Per i componenti di Communities forniti nella versione, le tabelle seguenti descrivono verbsdefiniti per ciascuna topicdisponibile per l'uso.

Argomenti e verbi topics-and-verbs

Componente calendario
SocialEvent topic= com/adobe/cq/social/calendar

Verbo
Descrizione
POST
un membro crea un evento calendario
AGGIUNGI
commenti dei membri su un evento calendario
AGGIORNA
modifica dell'evento calendario o del commento del membro
ELIMINA
l'evento o il commento del calendario del membro viene eliminato

Componente Commenti
SocialEvent topic= com/adobe/cq/social/comment

Verbo
Descrizione
POST
crea un commento
AGGIUNGI
risposta del membro al commento
AGGIORNA
modifica del commento del membro
ELIMINA
il commento del membro viene eliminato

Componente libreria file
SocialEvent topic= com/adobe/cq/social/fileLibrary

Verbo
Descrizione
POST
crea una cartella
ATTACCO
il membro carica un file
AGGIORNA
un membro aggiorna una cartella o un file
ELIMINA
elimina una cartella o un file

Componente Forum
SocialEvent topic= com/adobe/cq/social/forum

Verbo
Descrizione
POST
argomento del forum crea membri
AGGIUNGI
risposte dei membri all'argomento del forum
AGGIORNA
argomento forum o risposta del membro viene modificato
ELIMINA
l'argomento o la risposta del forum del membro è cancellata

Componente Journal
SocialEvent topic= com/adobe/cq/social/journal

Verbo
Descrizione
POST
crea un articolo di blog
AGGIUNGI
commenti di un membro su un articolo di blog
AGGIORNA
articolo o commento del blog del membro è modificato
ELIMINA
l'articolo o il commento del blog del membro è stato cancellato

Componente QnA
SocialEvent topic = com/adobe/cq/social/qna

Verbo
Descrizione
POST
crea una domanda QnA
AGGIUNGI
crea una risposta QnA
AGGIORNA
viene modificata la domanda o la risposta QnA del membro
SELEZIONA
risposta del membro selezionata
ANNULLA
la risposta del membro è deselezionata
ELIMINA
la domanda o la risposta QnA del membro viene eliminata

Componente Recensioni
SocialEvent topic= com/adobe/cq/social/review

Verbo
Descrizione
POST
crea revisione
AGGIORNA
modifica della revisione del membro
ELIMINA
la revisione del membro viene eliminata

Componente di valutazione
SocialEvent topic= com/adobe/cq/social/tally

Verbo
Descrizione
AGGIUNGI VALUTAZIONE
il contenuto del membro è stato valutato
RIMUOVI VALUTAZIONE
il contenuto del membro è stato valutato in modo non corretto

Componente di voto
SocialEvent topic= com/adobe/cq/social/tally

Verbo
Descrizione
AGGIUNGI VOTO
il contenuto del membro è stato votato
RIMUOVI VOTO
il contenuto del membro è stato respinto

Componenti abilitati per la moderazione
SocialEvent topic= com/adobe/cq/social/moderation

Verbo
Descrizione
RIFIUTA
contenuto del membro negato
FLAG-AS INAPPROPRIATO
il contenuto del membro è contrassegnato
NON APPROPRIATO
il contenuto del membro viene rimosso
ACCETTARE
il contenuto del membro è approvato dal moderatore
CHIUDI
il membro chiude il commento alle modifiche e alle risposte
APERTO
riapre il commento

Eventi per componenti personalizzati events-for-custom-components

Per un componente personalizzato, la Classe astratta SocialEvent deve essere esteso d per registrare gli eventi del componente come actionsche si verificano per topic.

L'evento personalizzato sostituisce il metodo getVerb() in modo che verbviene restituito per ogni action. La verb restituita per un’azione può essere comunemente utilizzata (ad esempio POST) o uno specializzato per il componente (ad esempio ADD RATING). C'è un n-1 rapporto tra actionse verbs.

NOTE
Assicurati che un'estensione personalizzata sia registrata con una classificazione inferiore a qualsiasi implementazione esistente nel prodotto.

Pseudo-codice per evento componente personalizzato pseudo-code-for-custom-component-event

org.osgi.service.event.Event;
com.adobe.cq.sosocial.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");
            }
        }
    }

}

Esempio di EventListener per filtrare i dati del flusso di attività sample-eventlistener-to-filter-activity-stream-data

È possibile ascoltare gli eventi allo scopo di modificare ciò che appare nel flusso di attività.

Il seguente esempio di pseudo-codice rimuove gli eventi DELETE per il componente Commenti dal flusso di attività.

Pseudo-codice per EventListener pseudo-code-for-eventlistener

Richiede pacchetto di funzionalità più recente.

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[]{"*"};
    }

}
recommendation-more-help
5d37d7b0-a330-461b-814d-068612705ff6