Class RetrieveInboxMessagesForOneAccountResource
java.lang.Object
esendex.sdk.java.service.resource.base.Resource
esendex.sdk.java.service.resource.base.XmlResponderResource<MessageCollectionResponseDto>
esendex.sdk.java.service.resource.message.RetrieveInboxMessagesForOneAccountResource
public class RetrieveInboxMessagesForOneAccountResource
extends XmlResponderResource<MessageCollectionResponseDto>
This operation will return a paged response of all inbound messages to one
Account that the user has permissions to view. The Account is specified by
adding the Reference to the URI.
- Author:
- Mike Whittaker
-
Constructor Summary
ConstructorsConstructorDescriptionRetrieveInboxMessagesForOneAccountResource
(Authenticator auth, String account) Instantiates a new retrieve inbox messages for one account resource.RetrieveInboxMessagesForOneAccountResource
(Authenticator auth, String account, HttpQuery query) Instantiates a new retrieve inbox messages for one account resource. -
Method Summary
Modifier and TypeMethodDescriptionprotected String
Gets the child portion of the url required to access the resource.protected HttpRequestMethod
Gets the HttpRequestMethod that this service stipulates eg GET, POST, PUT, DELETE.Methods inherited from class esendex.sdk.java.service.resource.base.XmlResponderResource
execute, getResponseObject
Methods inherited from class esendex.sdk.java.service.resource.base.Resource
getAccount, getEndpoint, getId, getRequestData, getResponse, isHttpOkay
-
Constructor Details
-
RetrieveInboxMessagesForOneAccountResource
public RetrieveInboxMessagesForOneAccountResource(Authenticator auth, String account, HttpQuery query) Instantiates a new retrieve inbox messages for one account resource.- Parameters:
auth
- the authenticatoraccount
- the accountquery
- the query
-
RetrieveInboxMessagesForOneAccountResource
Instantiates a new retrieve inbox messages for one account resource.- Parameters:
auth
- the authenticatoraccount
- the account
-
-
Method Details
-
getRequestMethod
Gets the HttpRequestMethod that this service stipulates eg GET, POST, PUT, DELETE.- Specified by:
getRequestMethod
in classResource
- Returns:
- the required HttpRequestMethod
-
getEndpointChild
Gets the child portion of the url required to access the resource. The child part is appended to the base url and must not start with a '/' The base url is of the form 'http://api.esendex.com/{version}/' where version maybe similar to 'v1.0'- Specified by:
getEndpointChild
in classResource
- Returns:
- the child portion of the url required to access this resource
-