java.lang.Object | |
↳ | com.kinvey.java.CustomEndpoints<I, O> |
Class for managing access to custom endpoints.
After defining a Custom Endpoint on a backend at Kinvey, this class can be used to execute remote commands.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | CustomEndpoints.CustomCommand | A JSON client request which executes against a custom endpoint returning a single JSON object. | |||||||||
class | CustomEndpoints.CustomCommandArray | A JSON client request which executes against a custom endpoint returning an array. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CustomEndpoints(AbstractClient client)
Create a new instance, should only be called by an
AbstractClient . | |||||||||||
CustomEndpoints(Class<O> responseClass, AbstractClient client)
Create a new instance, should only be called by an
AbstractClient |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CustomCommandArray |
callEndpointArrayBlocking(String endpoint, I input)
Execute a Custom Endpoint which returns an array of JSON elements.
| ||||||||||
CustomCommand |
callEndpointBlocking(String endpoint, I input)
Execute a Custom Endpoint which returns a single JSON element
| ||||||||||
void | clearCustomRequestProperties() | ||||||||||
Class<O> | getCurrentResponseClass() | ||||||||||
void | setClientAppVersion(int major, int minor, int revision) | ||||||||||
void | setClientAppVersion(String appVersion) | ||||||||||
void | setCustomRequestProperties(GenericJson customheaders) | ||||||||||
void | setCustomRequestProperty(String key, Object value) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Create a new instance, should only be called by an AbstractClient
.
client | - an active logged in Client |
---|
Create a new instance, should only be called by an AbstractClient
responseClass | the class of the response object |
---|---|
client | - an active logged in client |
Execute a Custom Endpoint which returns an array of JSON elements.
endpoint | - the name of the Custom Endpoint |
---|---|
input | - any required input, can be null |
IOException |
---|
Execute a Custom Endpoint which returns a single JSON element
endpoint | - the name of the Custom Endpoint |
---|---|
input | - any required input, can be null |
IOException |
---|