org.symphonyoss.client.ai

Class AiResponder

java.lang.Object

org.symphonyoss.client.ai.AiResponder

public class AiResponder
extends java.lang.Object

A part of the ai with the main purpose of responding back to a user

Constructor Summary

Constructors

Constructor and Description
AiResponder(SymphonyClient symClient)

Method Summary

Modifier and Type	Method and Description
SymphonyClient	getSymClient() Return Symphony client used with responder
void	respond(java.util.Set<AiResponseSequence> responseLists, java.lang.String streamId) Respond to stream (all users), based on the values and ids given in the set of responses
void	respondToEachUserWith(java.util.Set<AiResponseSequence> responseLists) Respond to the user, based on the values and ids given in the set of responses
void	sendMessage(java.lang.String message, java.lang.Long userID, SymphonyClient symClient) Sends a message to a user
void	sendMessage(java.lang.String message, SymStream stream, SymphonyClient symClient) Sends a message to a user
void	sendMessage(SymMessage message, SymStream stream, SymphonyClient symClient) Sends a message to a user
void	sendNoPermission(SymMessage message) Send a message back to the user, informing them that they do not have the required permission
void	sendSuggestionMessage(AiLastCommand suggestion, SymMessage message) Send a message back to the user, suggesting a command
void	sendUsage(SymMessage message, MlMessageParser mlMessageParser, java.util.ArrayList<AiCommand> activeCommands) Sends the command usage menu back to the user
void	setSymClient(SymphonyClient symClient) Set symphony client supporting internal calls

Methods inherited from class java.lang.Object

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

Constructor Detail

AiResponder

public AiResponder(SymphonyClient symClient)

Method Detail

sendMessage

public void sendMessage(java.lang.String message,
                        java.lang.Long userID,
                        SymphonyClient symClient)

Sends a message to a user

Parameters:

message - the message received from the user

userID - the id of the user

symClient - the org.org.symphonyoss.ai's sym client

sendMessage

public void sendMessage(java.lang.String message,
                        SymStream stream,
                        SymphonyClient symClient)

Sends a message to a user

Parameters:

message - the message received from the user

stream - the message stream

symClient - the org.org.symphonyoss.ai's sym client

sendMessage

public void sendMessage(SymMessage message,
                        SymStream stream,
                        SymphonyClient symClient)

Sends a message to a user

Parameters:

message - the message received from the user

stream - the message stream

symClient - the org.org.symphonyoss.ai's sym client

respondToEachUserWith

public void respondToEachUserWith(java.util.Set<AiResponseSequence> responseLists)

Respond to the user, based on the values and ids given in the set of responses

Parameters:

responseLists - the set of responses

respond

public void respond(java.util.Set<AiResponseSequence> responseLists,
                    java.lang.String streamId)

Respond to stream (all users), based on the values and ids given in the set of responses

Parameters:

responseLists - the set of responses

streamId - Stream ID

sendSuggestionMessage

public void sendSuggestionMessage(AiLastCommand suggestion,
                                  SymMessage message)

Send a message back to the user, suggesting a command

Parameters:

suggestion - the suggested command

message - the message received from the user

sendUsage

public void sendUsage(SymMessage message,
                      MlMessageParser mlMessageParser,
                      java.util.ArrayList<AiCommand> activeCommands)

Sends the command usage menu back to the user

Parameters:

message - the message received from the user

mlMessageParser - a parser that contains the input in ML

activeCommands - the active set of commands within the org.org.symphonyoss.ai command listener

sendNoPermission

public void sendNoPermission(SymMessage message)

Send a message back to the user, informing them that they do not have the required permission

Parameters:

message - the message received back from the user

getSymClient

public SymphonyClient getSymClient()

Return Symphony client used with responder

Returns:

SymphonyClient

setSymClient

public void setSymClient(SymphonyClient symClient)

Set symphony client supporting internal calls

Parameters:

symClient - Symphony client