SmsMessage Class Reference

Class for setting parameters for a SMS message. More...

#include <SmsWebhookRK.h>

Public Member Functions
	SmsMessage ()
	Default constructor - doesn't really do anything.
virtual	~SmsMessage ()
	Default destructor - doesn't really do anything.
SmsMessage &	withRecipient (const char *phoneNum)
	Sets the recipient phone number. More...
const char *	getRecipient () const
	Gets the previously set phone number.
bool	hasRecipient () const
	Returns true if the recipient is a non-empty recipient string.
SmsMessage &	withMessage (const char *message)
	Sets the SMS message text. More...
const char *	getMessage () const
	Gets the previously set message text.

Protected Attributes
String	recipient
	Recipient phone number (+ country code format)
String	message
	Message text to send.

Detailed Description

Class for setting parameters for a SMS message.

You typically use it like:

SmsMessage mesg;
mesg.withRecipient("+12125551212")
    .withMessage(String::format("Message %d!", ++counter));
SmsWebhook::instance().queueSms(mesg);

Member Function Documentation

withMessage()

SmsMessage& SmsMessage::withMessage ( const char *  message )

inline

Sets the SMS message text.

Parameters

message

The SMS message text, limited to 140 characters.

Returns

*this so you can chain withXXX() calls, fluent-style

This method makes a copy of message string. If you don't set the message string, the Twilio API won't let you send an empty SMS, so an error will show in the integration log.

withRecipient()

SmsMessage& SmsMessage::withRecipient ( const char *  phoneNum )

inline

Sets the recipient phone number.

Parameters

phoneNum

Recipient phone number in + country code format, so for example, in the United States it begins with +1. The rest of the phone number should be be just digits, no punctuation.

Returns

*this so you can chain withXXX() calls, fluent-style

This method makes a copy of phoneNum string.

Instead of specifying the recipient in each SmsMessage object, you can use withRecipientCallback(). Providing a function to get the recipient is handy if you're storing the recipient in EEPROM or a file on the file system.

---

The documentation for this class was generated from the following file:

• src/SmsWebhookRK.h