public class

CustomEndpoints

extends Object
java.lang.Object
   ↳ com.kinvey.java.CustomEndpoints

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

Public Constructors
CustomEndpoints(AbstractClient client)
Create a new instance, should only be called by an AbstractClient.
Public Methods
CustomEndpoints.CustomCommandArray callEndpointArrayBlocking(String endpoint, GenericJson input)
Execute a Custom Endpoint which returns an array of JSON elements.
CustomEndpoints.CustomCommand callEndpointBlocking(String endpoint, GenericJson input)
Execute a Custom Endpoint which returns a single JSON element
[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 Methods

public CustomEndpoints.CustomCommandArray callEndpointArrayBlocking (String endpoint, GenericJson 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 CustomEndpoints.CustomCommand callEndpointBlocking (String endpoint, GenericJson 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