com.clicksend.controllers

Class SMSController

java.lang.Object

com.clicksend.controllers.BaseController

com.clicksend.controllers.SMSController

public class SMSController
extends BaseController

Field Summary

Fields inherited from class com.clicksend.controllers.BaseController

httpCallBack

Constructor Summary

Constructors

Constructor and Description
SMSController()

Method Summary

Modifier and Type	Method and Description
String	calculatePrice(SmsMessageCollection smsMessages) Calculate sms price
void	calculatePriceAsync(SmsMessageCollection smsMessages, APICallBack<String> callBack) Calculate sms price
String	cancelAllScheduledSms() Update all scheduled message as cancelled
void	cancelAllScheduledSmsAsync(APICallBack<String> callBack) Update all scheduled message as cancelled
String	cancelScheduledSms(int messageId) Update scheduled message as cancel
void	cancelScheduledSmsAsync(int messageId, APICallBack<String> callBack) Update scheduled message as cancel
String	createInboundSms(String url) Create inbound sms
void	createInboundSmsAsync(String url, APICallBack<String> callBack) Create inbound sms
String	createReceipt(String url) Add a delivery receipt
void	createReceiptAsync(String url, APICallBack<String> callBack) Add a delivery receipt
String	createSmsTemplate(SmsTemplate smsTemplate) Create sms template
void	createSmsTemplateAsync(SmsTemplate smsTemplate, APICallBack<String> callBack) Create sms template
String	deleteSmsTemplate(int templateId) Delete sms template
void	deleteSmsTemplateAsync(int templateId, APICallBack<String> callBack) Delete sms template
String	exportHistory(String filename) Export all sms history
void	exportHistoryAsync(String filename, APICallBack<String> callBack) Export all sms history
String	getDeliveryReceipts() Get all delivery receipts
void	getDeliveryReceiptsAsync(APICallBack<String> callBack) Get all delivery receipts
String	getInboundSms() Get all inbound sms
void	getInboundSmsAsync(APICallBack<String> callBack) Get all inbound sms
static SMSController	getInstance() Singleton pattern implementation
String	getSmsHistory(Integer dateFrom, Integer dateTo) Get all sms history
void	getSmsHistoryAsync(Integer dateFrom, Integer dateTo, APICallBack<String> callBack) Get all sms history
String	getSmsTemplates() Get lists of all sms templates
void	getSmsTemplatesAsync(APICallBack<String> callBack) Get lists of all sms templates
String	getSpecificDeliveryReceipt(int messageId) Get a Specific Delivery Receipt
void	getSpecificDeliveryReceiptAsync(int messageId, APICallBack<String> callBack) Get a Specific Delivery Receipt
String	markAllInboundSMSAsRead(String dateBefore) TODO: type endpoint description here
void	markAllInboundSMSAsReadAsync(String dateBefore, APICallBack<String> callBack) TODO: type endpoint description here
String	markReceiptsAsRead(String dateBefore) Marked delivery receipts as read
void	markReceiptsAsReadAsync(String dateBefore, APICallBack<String> callBack) Marked delivery receipts as read
String	sendSms(SmsMessageCollection smsMessages) TODO: type endpoint description here
void	sendSmsAsync(SmsMessageCollection smsMessages, APICallBack<String> callBack) TODO: type endpoint description here
String	updateSmsTemplate(String templateId, SmsTemplate smsTemplate) Update sms template
void	updateSmsTemplateAsync(String templateId, SmsTemplate smsTemplate, APICallBack<String> callBack) Update sms template

Methods inherited from class com.clicksend.controllers.BaseController

getClientInstance, getHttpCallBack, setClientInstance, setHttpCallBack, validateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

SMSController

public SMSController()

Method Detail

getInstance

public static SMSController getInstance()

Singleton pattern implementation

Returns:

The singleton instance of the SMSController class

sendSms

public String sendSms(SmsMessageCollection smsMessages)
               throws Throwable

TODO: type endpoint description here

Parameters:

smsMessages - Required parameter: Array of SmsMessage items

Returns:

Returns the String response from the API call

Throws:

Throwable

sendSmsAsync

public void sendSmsAsync(SmsMessageCollection smsMessages,
                         APICallBack<String> callBack)
                  throws com.fasterxml.jackson.core.JsonProcessingException

TODO: type endpoint description here

Parameters:

smsMessages - Required parameter: Array of SmsMessage items

Throws:

com.fasterxml.jackson.core.JsonProcessingException

calculatePrice

public String calculatePrice(SmsMessageCollection smsMessages)
                      throws Throwable

Calculate sms price

Parameters:

smsMessages - Required parameter: Array of SmsMessage items

Returns:

Returns the String response from the API call

Throws:

Throwable

calculatePriceAsync

public void calculatePriceAsync(SmsMessageCollection smsMessages,
                                APICallBack<String> callBack)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Calculate sms price

Parameters:

smsMessages - Required parameter: Array of SmsMessage items

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getSmsHistory

public String getSmsHistory(Integer dateFrom,
                            Integer dateTo)
                     throws Throwable

Get all sms history

Parameters:

dateFrom - Optional parameter: Start date

dateTo - Optional parameter: End date

Returns:

Returns the String response from the API call

Throws:

Throwable

getSmsHistoryAsync

public void getSmsHistoryAsync(Integer dateFrom,
                               Integer dateTo,
                               APICallBack<String> callBack)

Get all sms history

Parameters:

dateFrom - Optional parameter: Start date

dateTo - Optional parameter: End date

exportHistory

public String exportHistory(String filename)
                     throws Throwable

Export all sms history

Parameters:

filename - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

exportHistoryAsync

public void exportHistoryAsync(String filename,
                               APICallBack<String> callBack)

Export all sms history

Parameters:

filename - Required parameter: Example:

createReceipt

public String createReceipt(String url)
                     throws Throwable

Add a delivery receipt

Parameters:

url - Required parameter: Your url

Returns:

Returns the String response from the API call

Throws:

Throwable

createReceiptAsync

public void createReceiptAsync(String url,
                               APICallBack<String> callBack)

Add a delivery receipt

Parameters:

url - Required parameter: Your url

markReceiptsAsRead

public String markReceiptsAsRead(String dateBefore)
                          throws Throwable

Marked delivery receipts as read

Parameters:

dateBefore - Optional parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

markReceiptsAsReadAsync

public void markReceiptsAsReadAsync(String dateBefore,
                                    APICallBack<String> callBack)

Marked delivery receipts as read

Parameters:

dateBefore - Optional parameter: Example:

getInboundSms

public String getInboundSms()
                     throws Throwable

Get all inbound sms

Returns:

Returns the String response from the API call

Throws:

Throwable

getInboundSmsAsync

public void getInboundSmsAsync(APICallBack<String> callBack)

Get all inbound sms

createInboundSms

public String createInboundSms(String url)
                        throws Throwable

Create inbound sms

Parameters:

url - Required parameter: Your url

Returns:

Returns the String response from the API call

Throws:

Throwable

createInboundSmsAsync

public void createInboundSmsAsync(String url,
                                  APICallBack<String> callBack)

Create inbound sms

Parameters:

url - Required parameter: Your url

cancelScheduledSms

public String cancelScheduledSms(int messageId)
                          throws Throwable

Update scheduled message as cancel

Parameters:

messageId - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

cancelScheduledSmsAsync

public void cancelScheduledSmsAsync(int messageId,
                                    APICallBack<String> callBack)

Update scheduled message as cancel

Parameters:

messageId - Required parameter: Example:

cancelAllScheduledSms

public String cancelAllScheduledSms()
                             throws Throwable

Update all scheduled message as cancelled

Returns:

Returns the String response from the API call

Throws:

Throwable

cancelAllScheduledSmsAsync

public void cancelAllScheduledSmsAsync(APICallBack<String> callBack)

Update all scheduled message as cancelled

createSmsTemplate

public String createSmsTemplate(SmsTemplate smsTemplate)
                         throws Throwable

Create sms template

Parameters:

smsTemplate - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

createSmsTemplateAsync

public void createSmsTemplateAsync(SmsTemplate smsTemplate,
                                   APICallBack<String> callBack)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Create sms template

Parameters:

smsTemplate - Required parameter: Example:

Throws:

com.fasterxml.jackson.core.JsonProcessingException

deleteSmsTemplate

public String deleteSmsTemplate(int templateId)
                         throws Throwable

Delete sms template

Parameters:

templateId - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

deleteSmsTemplateAsync

public void deleteSmsTemplateAsync(int templateId,
                                   APICallBack<String> callBack)

Delete sms template

Parameters:

templateId - Required parameter: Example:

updateSmsTemplate

public String updateSmsTemplate(String templateId,
                                SmsTemplate smsTemplate)
                         throws Throwable

Update sms template

Parameters:

templateId - Required parameter: Example:

smsTemplate - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

updateSmsTemplateAsync

public void updateSmsTemplateAsync(String templateId,
                                   SmsTemplate smsTemplate,
                                   APICallBack<String> callBack)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Update sms template

Parameters:

templateId - Required parameter: Example:

smsTemplate - Required parameter: Example:

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getDeliveryReceipts

public String getDeliveryReceipts()
                           throws Throwable

Get all delivery receipts

Returns:

Returns the String response from the API call

Throws:

Throwable

getDeliveryReceiptsAsync

public void getDeliveryReceiptsAsync(APICallBack<String> callBack)

Get all delivery receipts

getSmsTemplates

public String getSmsTemplates()
                       throws Throwable

Get lists of all sms templates

Returns:

Returns the String response from the API call

Throws:

Throwable

getSmsTemplatesAsync

public void getSmsTemplatesAsync(APICallBack<String> callBack)

Get lists of all sms templates

markAllInboundSMSAsRead

public String markAllInboundSMSAsRead(String dateBefore)
                               throws Throwable

TODO: type endpoint description here

Parameters:

dateBefore - Optional parameter: An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read.

Returns:

Returns the String response from the API call

Throws:

Throwable

markAllInboundSMSAsReadAsync

public void markAllInboundSMSAsReadAsync(String dateBefore,
                                         APICallBack<String> callBack)

TODO: type endpoint description here

Parameters:

dateBefore - Optional parameter: An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read.

getSpecificDeliveryReceipt

public String getSpecificDeliveryReceipt(int messageId)
                                  throws Throwable

Get a Specific Delivery Receipt

Parameters:

messageId - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

getSpecificDeliveryReceiptAsync

public void getSpecificDeliveryReceiptAsync(int messageId,
                                            APICallBack<String> callBack)

Get a Specific Delivery Receipt

Parameters:

messageId - Required parameter: Example: