org.xwiki.netflux.internal.Bot Maven / Gradle / Ivy

Go to download
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.netflux.internal;

import java.util.List;

import org.xwiki.component.annotation.Role;

/**
 * Represents a fake user that joins a {@link Channel} to perform a specific task.
 *
 * @version $Id: 0d26c07e2f373a449de9a84779d3306a51b856dc $
 * @since 15.10.11
 * @since 16.4.1
 * @since 16.5.0RC1
 */
@Role
public interface Bot
{
    /**
     * @return the hex string that identifies this fake user
     */
    String getId();

    /**
     * Called to ask a bot if it accepts to join a channel. The bots accept to join all channels by default. Use this
     * method to filter the channels that the bot should join.
     *
     * @param channel the channel the bot is asked to join
     * @return {@code true} if the bot accepts to join the channel, {@code false} otherwise
     */
    default boolean onJoinChannel(Channel channel)
    {
        return true;
    }

    /**
     * Called when a direct message is received from a user.
     *
     * @param sender the user who sent the message
     * @param message the message that was sent
     */
    default void onUserMessage(User sender, List