org.apache.unomi.mailchimp.services

Interface MailChimpService

All Known Implementing Classes:

MailChimpServiceImpl

public interface MailChimpService

Method Summary

Modifier and Type	Method and Description
MailChimpResult	addToMCList(Profile profile, Action action) This function will add the current visitor to a MailChimp list.
List<HashMap<String,String>>	getAllLists() This function will get all MailChimp lists.
MailChimpResult	removeFromMCList(Profile profile, Action action) This function will remove the current visitor from a MailChimp list.
MailChimpResult	unsubscribeFromMCList(Profile profile, Action action) This function will unsbscribe the current visitor to a MailChimp list.
MailChimpResult	updateMCProfileProperties(Profile profile, Action action) This function will update merge properties of MailChimp list.

Method Detail

getAllLists

List<HashMap<String,String>> getAllLists()

This function will get all MailChimp lists.

Returns:

a List of MailChimp lists with the name and the id.

addToMCList

MailChimpResult addToMCList(Profile profile,
                            Action action)

This function will add the current visitor to a MailChimp list.

Parameters:

profile - the Unomi profile to add to the list @see org.apache.unomi.api.Profile

action - the action used to call this method, to retrieve parameters @see org.apache.unomi.api.actions.Action

Returns:

true if the visitor is successfully added to a MailChimp list.

removeFromMCList

MailChimpResult removeFromMCList(Profile profile,
                                 Action action)

This function will remove the current visitor from a MailChimp list.

Parameters:

profile - the Unomi profile to remove from the list @see org.apache.unomi.api.Profile

action - the action used to call this method, to retrieve parameters @see org.apache.unomi.api.actions.Action

Returns:

true if the visitor is successfully removed to a MailChimp list.

unsubscribeFromMCList

MailChimpResult unsubscribeFromMCList(Profile profile,
                                      Action action)

This function will unsbscribe the current visitor to a MailChimp list.

Parameters:

profile - the Unomi profile to unsubscribe from the list @see org.apache.unomi.api.Profile

action - the action used to call this method, to retrieve parameters @see org.apache.unomi.api.actions.Action

Returns:

true if the visitor is successfully unsbscribed to a MailChimp list.

updateMCProfileProperties

MailChimpResult updateMCProfileProperties(Profile profile,
                                          Action action)

This function will update merge properties of MailChimp list.

Parameters:

profile - the Unomi profile to unsubscribe from the list @see org.apache.unomi.api.Profile

action - the action used to call this method, to retrieve parameters @see org.apache.unomi.api.actions.Action

Returns:

true if the visitor is successfully unsbscribed to a MailChimp list.