Package com.novomind.ecom.api.iagent.messenger.connector

Interface MessengerConnectorMessageSender

All Known Subinterfaces:

MessengerConnector

public interface MessengerConnectorMessageSender

The MessengerConnectorMessageSender is an interface that implements the callback event functions triggered when messages need to be sent.

Since:

12.20

Method Summary

Modifier and Type	Method	Description
SentMessengerAudioDataMessage	sendAudioDataMessage(OutgoingMessengerAudioDataMessageInfo outgoingMessengerAudioDataMessageInfo)	The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.
SentMessengerFileDataMessage	sendFileDataMessage(OutgoingMessengerFileDataMessageInfo outgoingMessengerFileDataMessageInfo)	The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.
SentMessengerImageDataMessage	sendImageDataMessage(OutgoingMessengerImageDataMessageInfo outgoingMessengerImageDataMessageInfo)	The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.
SentMessengerRawMessage	sendRawMessage(OutgoingMessengerRawMessageInfo outgoingMessengerRawMessageInfo)	The method is called to send a raw message back to it's source or any other destination that can be addressed by this MessengerConnector.
SentMessengerTextMessage	sendTextMessage(OutgoingMessengerTextMessageInfo outgoingMessengerTextMessageInfo)	The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.
SentMessengerVideoDataMessage	sendVideoDataMessage(OutgoingMessengerVideoDataMessageInfo outgoingMessengerVideoDataMessageInfo)	The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.

Method Detail

sendTextMessage

SentMessengerTextMessage sendTextMessage(OutgoingMessengerTextMessageInfo outgoingMessengerTextMessageInfo)
                                  throws MessengerConnectorPermanentSendException,
                                         MessengerConnectorTemporarySendException

The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.

Parameters:

outgoingMessengerTextMessageInfo - the outgoingMessengerTextMessageInfo object containing the message to be sent and additional information about the message

Returns:

the message that has been sent

Throws:

MessengerConnectorPermanentSendException - Throw a MessengerConnectorPermanentSendException to indicate a permanent error.

MessengerConnectorTemporarySendException - Throw a MessengerConnectorTemporarySendException to indicate a temporary error. The system will attempt to send the message again after a short period of time.

Since:

12.20

sendImageDataMessage

SentMessengerImageDataMessage sendImageDataMessage(OutgoingMessengerImageDataMessageInfo outgoingMessengerImageDataMessageInfo)
                                            throws MessengerConnectorPermanentSendException,
                                                   MessengerConnectorTemporarySendException

The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.

Parameters:

outgoingMessengerImageDataMessageInfo - the outgoingMessengerImageDataMessageInfo object containing the message to be sent and additional information about the message

Returns:

the message that has been sent

Throws:

MessengerConnectorPermanentSendException - Throw a MessengerConnectorPermanentSendException to indicate a permanent error.

MessengerConnectorTemporarySendException - Throw a MessengerConnectorTemporarySendException to indicate a temporary error. The system will attempt to send the message again after a short period of time.

Since:

12.20

sendAudioDataMessage

SentMessengerAudioDataMessage sendAudioDataMessage(OutgoingMessengerAudioDataMessageInfo outgoingMessengerAudioDataMessageInfo)
                                            throws MessengerConnectorPermanentSendException,
                                                   MessengerConnectorTemporarySendException

The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.

Parameters:

outgoingMessengerAudioDataMessageInfo - the outgoingMessengerAudioDataMessageInfo object containing the message to be sent and additional information about the message

Returns:

the message that has been sent

Throws:

MessengerConnectorPermanentSendException - Throw a MessengerConnectorPermanentSendException to indicate a permanent error.

MessengerConnectorTemporarySendException - Throw a MessengerConnectorTemporarySendException to indicate a temporary error. The system will attempt to send the message again after a short period of time.

Since:

12.20

sendVideoDataMessage

SentMessengerVideoDataMessage sendVideoDataMessage(OutgoingMessengerVideoDataMessageInfo outgoingMessengerVideoDataMessageInfo)
                                            throws MessengerConnectorPermanentSendException,
                                                   MessengerConnectorTemporarySendException

The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.

Parameters:

outgoingMessengerVideoDataMessageInfo - the outgoingMessengerVideoDataMessageInfo object containing the message to be sent and additional information about the message

Returns:

the message that has been sent

Throws:

MessengerConnectorPermanentSendException - Throw a MessengerConnectorPermanentSendException to indicate a permanent error.

MessengerConnectorTemporarySendException - Throw a MessengerConnectorTemporarySendException to indicate a temporary error. The system will attempt to send the message again after a short period of time.

Since:

12.20

sendFileDataMessage

SentMessengerFileDataMessage sendFileDataMessage(OutgoingMessengerFileDataMessageInfo outgoingMessengerFileDataMessageInfo)
                                          throws MessengerConnectorPermanentSendException,
                                                 MessengerConnectorTemporarySendException

The method is called to send the message back to it's source or any other destination that can be addressed by this MessengerConnector.

Parameters:

outgoingMessengerFileDataMessageInfo - the outgoingMessengerFileDataMessageInfo object containing the message to be sent and additional information about the message

Returns:

the message that has been sent

Throws:

MessengerConnectorPermanentSendException - Throw a MessengerConnectorPermanentSendException to indicate a permanent error.

MessengerConnectorTemporarySendException - Throw a MessengerConnectorTemporarySendException to indicate a temporary error. The system will attempt to send the message again after a short period of time.

Since:

12.20

sendRawMessage

SentMessengerRawMessage sendRawMessage(OutgoingMessengerRawMessageInfo outgoingMessengerRawMessageInfo)
                                throws MessengerConnectorPermanentSendException,
                                       MessengerConnectorTemporarySendException

The method is called to send a raw message back to it's source or any other destination that can be addressed by this MessengerConnector.

Parameters:

outgoingMessengerRawMessageInfo - the outgoingMessengerRawMessageInfo object containing the message to be sent and additional information about the message

Returns:

the message that has been sent

Throws:

MessengerConnectorPermanentSendException - Throw a MessengerConnectorPermanentSendException to indicate a permanent error.

MessengerConnectorTemporarySendException - Throw a MessengerConnectorTemporarySendException to indicate a temporary error. The system will attempt to send the message again after a short period of time.

Since:

12.0