co.aurasphere.botmill.fb.bean

Class FbBotMillBean

java.lang.Object

co.aurasphere.botmill.fb.bean.FbBotMillBean

Direct Known Subclasses:

AccountLinkingEvent, AnyMessageEvent, AnyPostbackEvent, AutoReply, BaseMediaEvent, BasePatternEvent, BaseStringEvent, FbBotMillResponseBuilder, LocationEvent, ReferralEvent

public class FbBotMillBean
extends Object

Base FbBot bean which contains utility methods for handling an envelope.

Author:

Donato Rimenti, Alvin Reyes

Constructor Summary

Constructors

Constructor and Description
FbBotMillBean()

Method Summary

Modifier and Type	Method and Description
protected FbBotMillEventType	eventKind(MessageEnvelope envelope) Returns the kind of callback received for the current envelope.
protected Attachment	getAudioMessage(MessageEnvelope envelope) Gets the audio message.
protected Attachment	getFileMessage(MessageEnvelope envelope) Gets the file message.
protected Attachment	getImageMessage(MessageEnvelope envelope) Gets the image message.
protected LocationCoordinates	getLocationMessage(MessageEnvelope envelope) Retrieves the location from an envelope.
protected Attachment	getVideoMessage(MessageEnvelope envelope) Gets the video message.
protected String	safeGetMessage(MessageEnvelope envelope) Retrieves a text message from an envelope.
protected String	safeGetPostbackPayload(MessageEnvelope envelope) Retrieves a text message from an envelope.
protected String	safeGetQuickReplyPayload(MessageEnvelope envelope) Retrieves a quick reply payload from an envelope.
protected User	safeGetRecipient(MessageEnvelope envelope) Retrieves the recipient from an envelope.
protected String	safeGetRecipientId(MessageEnvelope envelope) Retrieves the recipient ID from an envelope.
protected User	safeGetSender(MessageEnvelope envelope) Retrieves the sender from an envelope.
protected String	safeGetSenderId(MessageEnvelope envelope) Retrieves the sender ID from an envelope.
String	toString()
protected boolean	validate(FbBotMillResponse response) Validates the FbBotMillResponse.

Methods inherited from class java.lang.Object

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

Constructor Detail

FbBotMillBean

public FbBotMillBean()

Method Detail

safeGetMessage

protected String safeGetMessage(MessageEnvelope envelope)

Retrieves a text message from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

the text message if found or an empty String otherwise. It never returns null.

safeGetQuickReplyPayload

protected String safeGetQuickReplyPayload(MessageEnvelope envelope)

Retrieves a quick reply payload from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

the text message if found or an empty String otherwise. It never returns null.

safeGetPostbackPayload

protected String safeGetPostbackPayload(MessageEnvelope envelope)

Retrieves a text message from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

the message envelope if found or an empty String otherwise. It never returns null.

safeGetRecipientId

protected String safeGetRecipientId(MessageEnvelope envelope)

Retrieves the recipient ID from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

the recipient ID if found or an empty String otherwise. It never returns null.

safeGetSenderId

protected String safeGetSenderId(MessageEnvelope envelope)

Retrieves the sender ID from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

the sender ID if found or an empty String otherwise. It never returns null.

safeGetRecipient

protected User safeGetRecipient(MessageEnvelope envelope)

Retrieves the recipient from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

a User containing the recipient if found, empty otherwise. It never returns null.

getLocationMessage

protected LocationCoordinates getLocationMessage(MessageEnvelope envelope)

Retrieves the location from an envelope. It return nulls if none was retrieved.

Parameters:

envelope - the message envelope

Returns:

a LocationCoordinates containing the coordinates that the user sets from the quick reply location payload.

getImageMessage

protected Attachment getImageMessage(MessageEnvelope envelope)

Gets the image message.

Parameters:

envelope - the envelope

Returns:

the image message

getAudioMessage

protected Attachment getAudioMessage(MessageEnvelope envelope)

Gets the audio message.

Parameters:

envelope - the envelope

Returns:

the audio message

getVideoMessage

protected Attachment getVideoMessage(MessageEnvelope envelope)

Gets the video message.

Parameters:

envelope - the envelope

Returns:

the video message

getFileMessage

protected Attachment getFileMessage(MessageEnvelope envelope)

Gets the file message.

Parameters:

envelope - the envelope

Returns:

the file message

safeGetSender

protected User safeGetSender(MessageEnvelope envelope)

Retrieves the sender from an envelope. It never returns null.

Parameters:

envelope - the message envelope.

Returns:

a User containing the sender if found, empty otherwise. It never returns null.

eventKind

protected FbBotMillEventType eventKind(MessageEnvelope envelope)

Returns the kind of callback received for the current envelope.

Parameters:

envelope - the envelope to inspect.

Returns:

a FbBotMillEventType representing the current callback type.

validate

protected boolean validate(FbBotMillResponse response)

Validates the FbBotMillResponse.

Parameters:

response - the response

Returns:

true if the response is valid, false otherwise.

toString

public String toString()

Overrides:

toString in class Object