Package com.mailersend.sdk.sms.recipients

Class SmsRecipients

java.lang.Object

com.mailersend.sdk.sms.recipients.SmsRecipients

public class SmsRecipients
extends Object

SmsRecipients class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Constructor	Description
SmsRecipients(MailerSend ref)	Constructor for SmsRecipients.

Method Summary

Modifier and Type	Method	Description
SmsRecipient	getRecipient(String recipientId)	getRecipient.
SmsRecipientList	getRecipients()	getRecipients.
SmsRecipients	limit(int limit)	limit.
SmsRecipients	numberId(String numberId)	numberId.
SmsRecipients	page(int page)	page.
SmsRecipients	status(String status)	status.
SmsRecipient	updateRecipient(String recipientId, String status)	updateRecipient.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsRecipients

public SmsRecipients(MailerSend ref)

Constructor for SmsRecipients.

Parameters:

ref - a MailerSend object.

Method Detail

page

public SmsRecipients page(int page)

page.

Parameters:

page - a int.

Returns:

a SmsRecipients object.

limit

public SmsRecipients limit(int limit)

limit.

Parameters:

limit - a int.

Returns:

a SmsRecipients object.

status

public SmsRecipients status(String status)

status.

Parameters:

status - a String object.

Returns:

a SmsRecipients object.

numberId

public SmsRecipients numberId(String numberId)

numberId.

Parameters:

numberId - a String object.

Returns:

a SmsRecipients object.

getRecipients

public SmsRecipientList getRecipients()
                               throws MailerSendException

getRecipients.

Returns:

a SmsRecipientList object.

Throws:

MailerSendException - if any.

getRecipient

public SmsRecipient getRecipient(String recipientId)
                          throws MailerSendException

getRecipient.

Parameters:

recipientId - a String object.

Returns:

a SmsRecipient object.

Throws:

MailerSendException - if any.

updateRecipient

public SmsRecipient updateRecipient(String recipientId,
                                    String status)
                             throws MailerSendException

updateRecipient.

Parameters:

recipientId - a String object.

status - a String object.

Returns:

a SmsRecipient object.

Throws:

MailerSendException - if any.