Package org.cyclos.impl.utils.sms

Class ScriptSmsSender

java.lang.Object

org.cyclos.impl.utils.sms.ScriptSmsSender

All Implemented Interfaces:

SmsSender

public class ScriptSmsSender
extends Object
implements SmsSender

Implements a SmsSender which delegates to a script

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CONFIGURATION	Script attribute: the ConfigurationAccessor
static String	ATTR_MESSAGE	Script attribute: the SMS message to send.
static String	ATTR_PHONE	Script attribute: the resolved phone in Cyclos which received the operation.
static String	ATTR_PHONE_NUMBER	Script attribute: the phone number.
static String	FUNCTION_NAME	The function name called on scripts

Constructor Summary

Constructors

Constructor	Description
ScriptSmsSender()

Method Summary

Modifier and Type	Method	Description
OutboundSmsStatus	send(ConfigurationAccessor configuration, MobilePhone phone, String phoneNumber, String message)	Sends the sms message for the given phone, returning the send status.

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_NAME

public static final String FUNCTION_NAME

The function name called on scripts

See Also:

Constant Field Values

ATTR_CONFIGURATION

public static final String ATTR_CONFIGURATION

Script attribute: the ConfigurationAccessor

See Also:

Constant Field Values

ATTR_PHONE

public static final String ATTR_PHONE

Script attribute: the resolved phone in Cyclos which received the operation. Maybe null, if the phone is not yet registered in Cyclos

See Also:

Constant Field Values

ATTR_PHONE_NUMBER

public static final String ATTR_PHONE_NUMBER

Script attribute: the phone number. Never null

See Also:

Constant Field Values

ATTR_MESSAGE

public static final String ATTR_MESSAGE

Script attribute: the SMS message to send. Never null

See Also:

Constant Field Values

Constructor Detail

ScriptSmsSender

public ScriptSmsSender()

Method Detail

send

public OutboundSmsStatus send(ConfigurationAccessor configuration,
                              MobilePhone phone,
                              String phoneNumber,
                              String message)

Description copied from interface: SmsSender

Sends the sms message for the given phone, returning the send status. The phone object might be null when sending an SMS to a phone not registered in Cyclos

Specified by:

send in interface SmsSender