コミュニティコンポーネントの OSGi イベント osgi-events-for-communities-components

CAUTION
AEM 6.4 の拡張サポートは終了し、このドキュメントは更新されなくなりました。 詳細は、 技術サポート期間. サポートされているバージョンを見つける ここ.

概要 overview

メンバーが Communities 機能とやり取りすると、通知やゲーミフィケーション(スコアやバッジ)などの非同期リスナーをトリガーする OSGi イベントが送信されます。

コンポーネントの SocialEvent インスタンスは、イベントを actionsそれは topic. SocialEvent には、 verbアクションに関連付けられている。 ここに n-1 ~間の関係 actionsおよび verbs.

リリースで提供されるコミュニティコンポーネントについて、次の表で次の内容を説明します。 verbsそれぞれに定義 topic使用可能

トピックと動詞 topics-and-verbs

カレンダーコンポーネント
SocialEvent topic= com/adobe/cq/social/calendar

動詞
説明
POST
メンバーがカレンダーイベントを作成する
追加
カレンダーイベントに対するメンバーのコメント
更新
メンバーのカレンダーイベントまたはコメントが編集されました
削除
メンバーのカレンダーイベントまたはコメントが削除されました

コメントコンポーネント
SocialEvent topic= com/adobe/cq/social/comment

動詞
説明
POST
メンバーがコメントを作成
追加
メンバーがコメントに返信しました
更新
メンバーのコメントが編集されます
削除
メンバーのコメントが削除されます

ファイルライブラリコンポーネント
SocialEvent topic= com/adobe/cq/social/fileLibrary

動詞
説明
POST
メンバーがフォルダーを作成
添付
メンバーはファイルをアップロードします
更新
メンバーがフォルダーまたはファイルを更新
削除
メンバーがフォルダまたはファイルを削除

フォーラムコンポーネント
SocialEvent topic= com/adobe/cq/social/forum

動詞
説明
POST
メンバーがフォーラムトピックを作成します
追加
フォーラムトピックに返信するメンバー
更新
メンバーのフォーラムのトピックまたは返信が編集されます
削除
メンバーのフォーラムトピックまたは返信が削除されました

ジャーナルコンポーネント
SocialEvent topic= com/adobe/cq/social/journal

動詞
説明
POST
メンバーがブログ記事を作成します
追加
メンバーがブログ記事にコメントを投稿
更新
メンバーのブログ記事またはコメントが編集されます
削除
メンバーのブログ記事またはコメントが削除されました

Q&A コンポーネント
SocialEvent topic = com/adobe/cq/social/qna

動詞
説明
POST
メンバーが Q&A 質問を作成
追加
メンバーが Q&A 回答を作成
更新
メンバーの Q&A の質問または回答が編集されます
選択
メンバーの回答が選択されています
選択解除
メンバーの回答が選択解除されました
削除
メンバーの Q&A の質問または回答が削除されます

レビューコンポーネント
SocialEvent topic= com/adobe/cq/social/review

動詞
説明
POST
メンバーがレビューを作成
更新
メンバーのレビューが編集されます
削除
メンバーのレビューが削除されます

評価コンポーネント
SocialEvent topic= com/adobe/cq/social/tally

動詞
説明
評価を追加
メンバーのコンテンツが評価されました
評価を削除
メンバーのコンテンツが評価を下げました

投票コンポーネント
SocialEvent topic= com/adobe/cq/social/tally

動詞
説明
投票を追加
メンバーのコンテンツが投票に参加しました
投票を削除
メンバーのコンテンツが投票で否決されました

モデレートが有効なコンポーネント
SocialEvent topic= com/adobe/cq/social/moderation

動詞
説明
拒否
メンバーのコンテンツが拒否されました
「不適切」のフラグ
メンバーのコンテンツにフラグが設定されています
不適切としてフラグ解除
メンバーの内容にフラグが設定解除されました
ACCEPT
メンバーのコンテンツがモデレーターによって承認されました
閉じる
メンバーが編集と返信に対するコメントを閉じる
開く
メンバーがコメントを再度開く

カスタムコンポーネントのイベント events-for-custom-components

カスタムコンポーネントの場合、 SocialEvent 抽象クラス コンポーネントのイベントを次の形式で記録するために、を拡張する必要があります。 actionsそれは topic.

カスタムイベントは、メソッドをオーバーライドします。 getVerb() 適切な verbが返される action. この verb アクションに対して返されるのは、一般的に使用される ( POST) またはコンポーネント専用の ( 例えば ADD RATING) をクリックします。 ここに n-1 ~間の関係 actionsおよび verbs.

NOTE
カスタム拡張機能が、製品内の既存の実装よりも低いランクで登録されていることを確認します。

カスタムコンポーネントイベントの擬似コード pseudo-code-for-custom-component-event

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");
            }
        }
    }

}

アクティビティストリームデータをフィルタリングする EventListener の例 sample-eventlistener-to-filter-activity-stream-data

アクティビティストリームに表示される内容を変更する目的で、イベントをリッスンできます。

次の擬似コードのサンプルを使用すると、コメントコンポーネントのDELETEイベントをアクティビティストリームから削除できます。

EventListener の擬似コード pseudo-code-for-eventlistener

必要 最新の機能パック.

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