me.timothy.bots.summon

Class SummonResponse

java.lang.Object

me.timothy.bots.summon.SummonResponse

public class SummonResponse
extends java.lang.Object

Describes how a summon will be responding. Unless otherwise specified, the response will be done through a comment to the relevant body. However, there is support to message specific individuals as part of a summon response.

Author:

Timothy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SummonResponse.ResponseType A brief description of what the response is saying (valid/invalid)

Constructor Summary

Constructors

Constructor and Description
SummonResponse(SummonResponse.ResponseType responseType, java.lang.String responseMessage) Creates a new response with no link flair
SummonResponse(SummonResponse.ResponseType responseType, java.lang.String responseMessage, java.lang.String linkFlairTemplateId) Creates a new response
SummonResponse(SummonResponse.ResponseType responseType, java.lang.String responseMessage, java.lang.String linkFlairTemplateId, java.util.List<PMResponse> pmResponses) Creates a new response
SummonResponse(SummonResponse.ResponseType responseType, java.lang.String responseMessage, java.lang.String linkFlairTemplateId, java.util.List<PMResponse> pmResponses, java.lang.String reportMessage)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLinkFlair()
java.util.List<PMResponse>	getPMResponses()
java.lang.String	getReportMessage()
java.lang.String	getResponseMessage()
SummonResponse.ResponseType	getResponseType()

Methods inherited from class java.lang.Object

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

Constructor Detail

SummonResponse

public SummonResponse(SummonResponse.ResponseType responseType,
                      java.lang.String responseMessage,
                      java.lang.String linkFlairTemplateId)

Creates a new response

Parameters:

responseType - the response type

responseMessage - the response message

linkFlairTemplateId - the flair that should be applied to the link

SummonResponse

public SummonResponse(SummonResponse.ResponseType responseType,
                      java.lang.String responseMessage,
                      java.lang.String linkFlairTemplateId,
                      java.util.List<PMResponse> pmResponses)

Creates a new response

Parameters:

responseType - the reponse type

responseMessage - the response message

linkFlairTemplateId - the flair that should be applied to the link

pmResponses - the pms that should be sent out (or null for none)

SummonResponse

public SummonResponse(SummonResponse.ResponseType responseType,
                      java.lang.String responseMessage,
                      java.lang.String linkFlairTemplateId,
                      java.util.List<PMResponse> pmResponses,
                      java.lang.String reportMessage)

SummonResponse

public SummonResponse(SummonResponse.ResponseType responseType,
                      java.lang.String responseMessage)

Creates a new response with no link flair

Parameters:

responseType - the type of response

responseMessage - the message of the response

Method Detail

getResponseType

public SummonResponse.ResponseType getResponseType()

Returns:

the response type

getResponseMessage

public java.lang.String getResponseMessage()

Returns:

the response

getLinkFlair

public java.lang.String getLinkFlair()

Returns:

the flair that should be applied to the link

getReportMessage

public java.lang.String getReportMessage()

Returns:

the report message for the link

getPMResponses

public java.util.List<PMResponse> getPMResponses()

Returns:

the pms that should be sent or null for none