public class

CustomEndpoints

extends Object
java.lang.Object
   ↳ com.kinvey.java.CustomEndpoints<I, O>

Class Overview

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.

Summary

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
Class<O> getCurrentResponseClass()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CustomEndpoints (AbstractClient client)

Create a new instance, should only be called by an AbstractClient.

Parameters
client - an active logged in Client

public CustomEndpoints (Class<O> responseClass, AbstractClient client)

Create a new instance, should only be called by an AbstractClient

Parameters
responseClass the class of the response object
client - an active logged in client

Public Methods

public CustomCommandArray callEndpointArrayBlocking (String endpoint, I input)

Execute a Custom Endpoint which returns an array of JSON elements.

Parameters
endpoint - the name of the Custom Endpoint
input - any required input, can be null
Returns
  • a CustomCommand ready to be executed
Throws
IOException

public CustomCommand callEndpointBlocking (String endpoint, I input)

Execute a Custom Endpoint which returns a single JSON element

Parameters
endpoint - the name of the Custom Endpoint
input - any required input, can be null
Returns
  • a CustomCommand request ready to be executed.
Throws
IOException

public Class<O> getCurrentResponseClass ()