Package esendex.sdk.java.service.impl
Class OptOutServiceImpl
java.lang.Object
esendex.sdk.java.service.impl.AbstractService
esendex.sdk.java.service.impl.OptOutServiceImpl
- All Implemented Interfaces:
OptOutService
-
Field Summary
Fields inherited from class esendex.sdk.java.service.impl.AbstractService
authenticator
-
Constructor Summary
ConstructorsConstructorDescriptionOptOutServiceImpl
(Authenticator authenticator) Instantiates a new opt outs service. -
Method Summary
Modifier and TypeMethodDescriptioncreateOptOut
(OptOutRequest optOutRequest) Creates an opt out.Gets an opt out.getOptOuts
(int pageNumber, int pageSize) Gets opt outs.getOptOuts
(FromAddress from, int pageNumber, int pageSize) Gets opt outs by from address.getOptOuts
(String account, int pageNumber, int pageSize) Gets opt outs by account reference.getOptOuts
(String account, FromAddress from, int pageNumber, int pageSize) Gets opt outs by account reference and from address.
-
Constructor Details
-
OptOutServiceImpl
Instantiates a new opt outs service.- Parameters:
authenticator
- the authenticator
-
-
Method Details
-
getOptOut
Gets an opt out.- Specified by:
getOptOut
in interfaceOptOutService
- Parameters:
id
- the id- Returns:
- the opt out
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
Gets opt outs.- Specified by:
getOptOuts
in interfaceOptOutService
- Parameters:
pageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
public OptOutCollectionResponse getOptOuts(String account, int pageNumber, int pageSize) throws EsendexException Gets opt outs by account reference.- Specified by:
getOptOuts
in interfaceOptOutService
- Parameters:
account
- the accountpageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
public OptOutCollectionResponse getOptOuts(FromAddress from, int pageNumber, int pageSize) throws EsendexException Gets opt outs by from address.- Specified by:
getOptOuts
in interfaceOptOutService
- Parameters:
from
- the from address filterpageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
getOptOuts
public OptOutCollectionResponse getOptOuts(String account, FromAddress from, int pageNumber, int pageSize) throws EsendexException Gets opt outs by account reference and from address.- Specified by:
getOptOuts
in interfaceOptOutService
- Parameters:
account
- the accountfrom
- the from address filterpageNumber
- the page numberpageSize
- the page size- Returns:
- the opt outs
- Throws:
EsendexException
- the Esendex exception
-
createOptOut
Creates an opt out.- Specified by:
createOptOut
in interfaceOptOutService
- Parameters:
optOutRequest
- the opt out to be created- Returns:
- the created opt out
- Throws:
EsendexException
- the Esendex exception
-