de.hybris.platform.mobileservices.text

Interface TextService

All Known Implementing Classes:

DefaultTextService

public interface TextService

The central service for sending text messages to a mobile device. Also this service provides management methods for shortcodes.

See Also:

PhoneListService, PhoneNumberService, MessagePricingStrategy

Method Summary

Modifier and Type	Method and Description
void	discard(MobileMessageContextModel message, MobileMessageError error, String errorMessage, Throwable cause) While processing a incoming message this methods allows to mark the message as discarded.
void	done(MobileMessageContextModel message) While processing a incoming message this methods allows to mark the message as done.
List<MobileShortcodeModel>	getAvailableShortcodesForSending(CountryModel country) Locates all shortcodes for the specified country which support sending of outgoing messages.
MobileShortcodeModel	getExclusiveShortCode(String shortCode) Looks up a exclusive shortcode using its unique code.
MobileShortcodeModel	getSharedShortCode(String shortCode, String keywordPrefix) Looks up a shared short code by a specified code and keywords
MobileMessageContextModel	replyWithLink(MobileMessageContextModel receivedMessage, String subject, String url) While processing a incoming message this methods allows to send a reply link message using the incoming message information.
MobileMessageContextModel	replyWithLink(MobileShortcodeModel shortcode, MobileMessageContextModel receivedMessage, String subject, String url) While processing a incoming message this methods allows to send a reply link message using the incoming message information.
MobileMessageContextModel	replyWithMessage(MobileMessageContextModel receivedMessage, String text) While processing a incoming message this methods allows to send a reply text message using the incoming message information.
MobileMessageContextModel	replyWithMessage(MobileShortcodeModel shortcode, MobileMessageContextModel receivedMessage, String text) While processing a incoming message this methods allows to send a reply text message using the incoming message information.
MobileMessageContextModel	sendLink(CountryModel country, PhoneNumberModel phone, String subject, String url) Convenience method delegating to sendLink(String, String, String, String).
MobileMessageContextModel	sendLink(MobileShortcodeModel shortcode, String countryIsoCode, String phone, String subject, String url) Sends a link SMS message to the specified number.
MobileMessageContextModel	sendLink(PhoneNumberModel phone, String subject, String url) Convenience method delegating to sendLink(String, String, String, String).
MobileMessageContextModel	sendLink(String countryIsoCode, String phone, String subject, String url) Sends a link SMS message to the specified number.
MobileMessageContextModel	sendMessage(CountryModel country, PhoneNumberModel phone, String text) Convenience method delegating to sendMessage(String, String, String).
MobileMessageContextModel	sendMessage(MobileShortcodeModel shortcode, String countryIsoCode, String phone, String text) Sends a text SMS message to the specified number.
MobileMessageContextModel	sendMessage(PhoneNumberModel phone, String text) Convenience method delegating to sendMessage(String, String, String).
MobileMessageContextModel	sendMessage(String countryIsoCode, String phone, String text) Sends a text SMS message to the specified number.

Method Detail

getExclusiveShortCode

MobileShortcodeModel getExclusiveShortCode(String shortCode)

Looks up a exclusive shortcode using its unique code.

Parameters:

shortCode - the code to look for

getSharedShortCode

MobileShortcodeModel getSharedShortCode(String shortCode,
                                        String keywordPrefix)

Looks up a shared short code by a specified code and keywords

Parameters:

shortCode - the shared code

keywordPrefix - the keyword

getAvailableShortcodesForSending

List<MobileShortcodeModel> getAvailableShortcodesForSending(CountryModel country)

Locates all shortcodes for the specified country which support sending of outgoing messages.

Please note that the final routing decision is being done by the OutgoingMessageRoutingStrategy which is currently set up in the mobile spring configuration. This method will simply list all potential ones.

Parameters:

country -

sendMessage

MobileMessageContextModel sendMessage(MobileShortcodeModel shortcode,
                                      String countryIsoCode,
                                      String phone,
                                      String text)

Sends a text SMS message to the specified number. The specified MobileShortcodeModel will be used to send the message on behalf.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

countryIsoCode - the country for the given phone number

phone - the phone number

text - the message content

Returns:

the scheduled message context model

sendMessage

MobileMessageContextModel sendMessage(String countryIsoCode,
                                      String phone,
                                      String text)

Sends a text SMS message to the specified number. Internally a suitable MobileShortcodeModel will be found and the message is being sent using its aggregator.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Parameters:

countryIsoCode - the country for the given phone number

phone - the phone number

text - the message content

Returns:

the scheduled message context model

sendMessage

MobileMessageContextModel sendMessage(CountryModel country,
                                      PhoneNumberModel phone,
                                      String text)

Convenience method delegating to sendMessage(String, String, String).

Parameters:

country - is providing the country iso code for the given phone number

phone - the phone number

text - the message content

sendMessage

MobileMessageContextModel sendMessage(PhoneNumberModel phone,
                                      String text)

Convenience method delegating to sendMessage(String, String, String).

Parameters:

phone - the phone number model which contains both country and number data

text - the message content

sendLink

MobileMessageContextModel sendLink(MobileShortcodeModel shortcode,
                                   String countryIsoCode,
                                   String phone,
                                   String subject,
                                   String url)

Sends a link SMS message to the specified number. The specified MobileShortcodeModel will be used to send the message on behalf.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states.

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

countryIsoCode -

phone -

subject -

url -

Returns:

the scheduled message context model

sendLink

MobileMessageContextModel sendLink(String countryIsoCode,
                                   String phone,
                                   String subject,
                                   String url)

Sends a link SMS message to the specified number. Internally a suitable MobileShortcodeModel will be found and the message is being sent using its aggregator.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states.

Parameters:

countryIsoCode -

phone -

subject -

url -

Returns:

the scheduled message context model

sendLink

MobileMessageContextModel sendLink(CountryModel country,
                                   PhoneNumberModel phone,
                                   String subject,
                                   String url)

Convenience method delegating to sendLink(String, String, String, String).

Parameters:

country - is providing the country iso code for the given phone number

phone - the phone number

subject - the link subject

url - the link url

sendLink

MobileMessageContextModel sendLink(PhoneNumberModel phone,
                                   String subject,
                                   String url)

Convenience method delegating to sendLink(String, String, String, String).

Parameters:

phone - the phone number model which contains both country and number data

subject - the link subject

url - the link url

replyWithMessage

MobileMessageContextModel replyWithMessage(MobileShortcodeModel shortcode,
                                           MobileMessageContextModel receivedMessage,
                                           String text)

While processing a incoming message this methods allows to send a reply text message using the incoming message information.

The specified MobileShortcodeModel will be used to send the message on behalf.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

receivedMessage - the previously received message

text - the reply text

Returns:

the scheduled message

replyWithMessage

MobileMessageContextModel replyWithMessage(MobileMessageContextModel receivedMessage,
                                           String text)

While processing a incoming message this methods allows to send a reply text message using the incoming message information.

Internally the receiving MobileShortcodeModel may be used for sending or, if more appropriate a suitable short code will be chosen.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Parameters:

receivedMessage - the previously received message

text - the reply text

Returns:

the scheduled message

replyWithLink

MobileMessageContextModel replyWithLink(MobileShortcodeModel shortcode,
                                        MobileMessageContextModel receivedMessage,
                                        String subject,
                                        String url)

While processing a incoming message this methods allows to send a reply link message using the incoming message information.

The specified MobileShortcodeModel will be used to send the message on behalf.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

receivedMessage - the previously received message

subject - the reply link subject

url - the reply link url

Returns:

the scheduled message

replyWithLink

MobileMessageContextModel replyWithLink(MobileMessageContextModel receivedMessage,
                                        String subject,
                                        String url)

While processing a incoming message this methods allows to send a reply link message using the incoming message information.

Internally the receiving MobileShortcodeModel may be used for sending or, if more appropriate a suitable short code will be chosen.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Parameters:

receivedMessage - the previously received message

subject - the reply link subject

url - the reply link url

Returns:

the scheduled message

done

void done(MobileMessageContextModel message)

While processing a incoming message this methods allows to mark the message as done. Such a message is considered as processed without error. The mobile framework is allowed to either delete or archive it from now.

Since message processing is done by custom actions it is recommended that implementors signal the end of processing by calling either done(MobileMessageContextModel) or discard(MobileMessageContextModel, MobileMessageError, String, Throwable) in case no reply is being triggered.

Parameters:

message - the message to be marked as done.

discard

void discard(MobileMessageContextModel message,
             MobileMessageError error,
             String errorMessage,
             Throwable cause)

While processing a incoming message this methods allows to mark the message as discarded. It further allows optionally to specify a error type, message and even a causing exception to be specified. Such a message is considered as processed abnormally. Therefore the mobile framework may keep such messages for reporting reasons.

Since message processing is done by custom actions it is recommended that implementors signal the end of processing by calling either done(MobileMessageContextModel) or discard(MobileMessageContextModel, MobileMessageError, String, Throwable) in case no reply is being triggered.

Parameters:

message - the message to be marked as done.