public class MaileonContactFiltersService extends AbstractMaileonService
MaileonContactFiltersService
client sends operational requests to the ContactFiltersResource
.AbstractMaileonService.QueryParameters
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SERVICE |
MAILEON_XML_TYPE
Constructor and Description |
---|
MaileonContactFiltersService(MaileonConfiguration config)
Constructs a
MaileonContactFiltersService . |
Modifier and Type | Method and Description |
---|---|
ContactFilter |
getContactFilter(long contactFilterId)
Gets a contacts-filter according to a particular id.
|
Page<ContactFilter> |
getContactFilters(int pageSize,
int pageIndex)
Retuns a page of contact filters using the provided pagination settings.
|
int |
getContactFiltersCount()
Returns the total count of contact filters in the account.
|
void |
refreshContactFilterContacts(long contactFilterId,
long time)
Update contacts of a particular contacts filter synchronously.
|
void |
refreshContactFilterContacts(long contactFilterId,
long time,
boolean asynchronously)
Update contacts of a particular contacts filter.
|
void |
updateContactFilter(long contactFilterId,
ContactFilter newFilterData)
Updates a particular contacts filter with new settings.
|
delete, delete, delete, encodePath, get, get, get, isCompressionEnabled, isDebug, isRequestCompressionEnabled, post, post, post, put, put, put, setCompressionEnabled, setDebug, setRequestCompressionEnabled
public static final java.lang.String SERVICE
public MaileonContactFiltersService(MaileonConfiguration config)
MaileonContactFiltersService
.config
- Maileon API-Configuration.public int getContactFiltersCount() throws MaileonException
MaileonException
public Page<ContactFilter> getContactFilters(int pageSize, int pageIndex) throws MaileonException
pageSize
- required number of elements in the result page [1..1000].pageIndex
- starts with 1.ContactFilter
objects.MaileonException
public ContactFilter getContactFilter(long contactFilterId) throws MaileonException
contactFilterId
- id of the requested filterContactFilter
instanceMaileonException
public void updateContactFilter(long contactFilterId, ContactFilter newFilterData) throws MaileonException
contactFilterId
- id of the required filternewFilterData
- the new data with which the contact filter will be updated. Currently only the name of the underlying filter will be
updatedMaileonException
public void refreshContactFilterContacts(long contactFilterId, long time, boolean asynchronously) throws MaileonException
contactFilterId
- id of the required contacts filtertime
- actuality time. The filter is going to be updated if the last actualization has been done before the given timeasynchronously
- if true, then update will be queuedMaileonException
public void refreshContactFilterContacts(long contactFilterId, long time) throws MaileonException
contactFilterId
- id of the required contacts filtertime
- actuality time. The filter is going to be updated if the last actualization has been done before the given timeMaileonException
refreshContactFilterContacts(long, long, boolean)
Copyright © 2018. All Rights Reserved.