org.symphonyoss.client.ai

Class AiCommandListener

java.lang.Object

org.symphonyoss.client.ai.AiCommandListener

All Implemented Interfaces:

ChatListener

public class AiCommandListener
extends java.lang.Object
implements ChatListener

A class that listens in on a chat, and determines if the user's input matches a command.

Constructor Summary

Constructors

Constructor and Description
AiCommandListener(SymphonyClient symClient)

Method Summary

Modifier and Type	Method and Description
boolean	addCommand(AiCommand command)
java.util.ArrayList<AiCommand>	getActiveCommands()
SymMessage	getLastAnsweredMessage()
SymphonyClient	getSymClient()
static boolean	isCommand(SymMessage message, SymphonyClient symClient) A method that allows other classes to determine if a given message matches a command in this command listener
void	listenOn(Chat chat) Registers this listener to a given chat appropriately.
void	onChatMessage(SymMessage message) When a chat message is received, check if it starts with the command char.
boolean	removeCommand(AiCommand command)
void	stopListening(Chat chat) Removes this listener from the provided chat appropriately

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AiCommandListener

public AiCommandListener(SymphonyClient symClient)

Method Detail

isCommand

public static boolean isCommand(SymMessage message,
                                SymphonyClient symClient)

A method that allows other classes to determine if a given message matches a command in this command listener

Parameters:

message - the message

symClient - Symphony client

Returns:

True if the message is a command

onChatMessage

public void onChatMessage(SymMessage message)

When a chat message is received, check if it starts with the command char. If it does, process message.

Specified by:

onChatMessage in interface ChatListener

Parameters:

message - the received message

listenOn

public void listenOn(Chat chat)

Registers this listener to a given chat appropriately.

Parameters:

chat - The chat to listen on

stopListening

public void stopListening(Chat chat)

Removes this listener from the provided chat appropriately

Parameters:

chat - The chat to listen on

getActiveCommands

public java.util.ArrayList<AiCommand> getActiveCommands()

addCommand

public boolean addCommand(AiCommand command)

removeCommand

public boolean removeCommand(AiCommand command)

getSymClient

public SymphonyClient getSymClient()

getLastAnsweredMessage

public SymMessage getLastAnsweredMessage()