com.clicksend.controllers

Class ContactController

java.lang.Object

com.clicksend.controllers.BaseController

com.clicksend.controllers.ContactController

public class ContactController
extends BaseController

Field Summary

Fields inherited from class com.clicksend.controllers.BaseController

httpCallBack

Constructor Summary

Constructors

Constructor and Description
ContactController()

Method Summary

Modifier and Type	Method and Description
String	createContact(Contact contact, int listId) Create new contact
void	createContactAsync(Contact contact, int listId, APICallBack<String> callBack) Create new contact
String	deleteContact(int listId, int contactId) Delete a contact
void	deleteContactAsync(int listId, int contactId, APICallBack<String> callBack) Delete a contact
String	getContact(int listId, int contactId) Get a specific contact
void	getContactAsync(int listId, int contactId, APICallBack<String> callBack) Get a specific contact
String	getContacts(int listId) Get all contacts in a list
void	getContactsAsync(int listId, APICallBack<String> callBack) Get all contacts in a list
static ContactController	getInstance() Singleton pattern implementation
String	removeOptedOutContacts(int listId, int optOutListId) Remove all opted out contacts
void	removeOptedOutContactsAsync(int listId, int optOutListId, APICallBack<String> callBack) Remove all opted out contacts
String	updateContact(int listId, int contactId, Contact contact) Update contact
void	updateContactAsync(int listId, int contactId, Contact contact, APICallBack<String> callBack) Update contact

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

ContactController

public ContactController()

Method Detail

getInstance

public static ContactController getInstance()

Singleton pattern implementation

Returns:

The singleton instance of the ContactController class

createContact

public String createContact(Contact contact,
                            int listId)
                     throws Throwable

Create new contact

Parameters:

contact - Required parameter: contact model

listId - Required parameter: List id

Returns:

Returns the String response from the API call

Throws:

Throwable

createContactAsync

public void createContactAsync(Contact contact,
                               int listId,
                               APICallBack<String> callBack)
                        throws com.fasterxml.jackson.core.JsonProcessingException

Create new contact

Parameters:

contact - Required parameter: contact model

listId - Required parameter: List id

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getContacts

public String getContacts(int listId)
                   throws Throwable

Get all contacts in a list

Parameters:

listId - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

getContactsAsync

public void getContactsAsync(int listId,
                             APICallBack<String> callBack)

Get all contacts in a list

Parameters:

listId - Required parameter: Example:

updateContact

public String updateContact(int listId,
                            int contactId,
                            Contact contact)
                     throws Throwable

Update contact

Parameters:

listId - Required parameter: Your list id

contactId - Required parameter: Your contact id

contact - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

updateContactAsync

public void updateContactAsync(int listId,
                               int contactId,
                               Contact contact,
                               APICallBack<String> callBack)
                        throws com.fasterxml.jackson.core.JsonProcessingException

Update contact

Parameters:

listId - Required parameter: Your list id

contactId - Required parameter: Your contact id

contact - Required parameter: Example:

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getContact

public String getContact(int listId,
                         int contactId)
                  throws Throwable

Get a specific contact

Parameters:

listId - Required parameter: Your contact list id you want to access.

contactId - Required parameter: Your contact id you want to access.

Returns:

Returns the String response from the API call

Throws:

Throwable

getContactAsync

public void getContactAsync(int listId,
                            int contactId,
                            APICallBack<String> callBack)

Get a specific contact

Parameters:

listId - Required parameter: Your contact list id you want to access.

contactId - Required parameter: Your contact id you want to access.

removeOptedOutContacts

public String removeOptedOutContacts(int listId,
                                     int optOutListId)
                              throws Throwable

Remove all opted out contacts

Parameters:

listId - Required parameter: Your list id

optOutListId - Required parameter: Your opt out list id

Returns:

Returns the String response from the API call

Throws:

Throwable

removeOptedOutContactsAsync

public void removeOptedOutContactsAsync(int listId,
                                        int optOutListId,
                                        APICallBack<String> callBack)

Remove all opted out contacts

Parameters:

listId - Required parameter: Your list id

optOutListId - Required parameter: Your opt out list id

deleteContact

public String deleteContact(int listId,
                            int contactId)
                     throws Throwable

Delete a contact

Parameters:

listId - Required parameter: Example:

contactId - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

deleteContactAsync

public void deleteContactAsync(int listId,
                               int contactId,
                               APICallBack<String> callBack)

Delete a contact

Parameters:

listId - Required parameter: Example:

contactId - Required parameter: Example: