Menu

API Reference

public class

Client

extends AbstractClient<T extends BaseUser>
java.lang.Object
   ↳ com.kinvey.java.core.AbstractKinveyClient
     ↳ com.kinvey.java.core.AbstractKinveyJsonClient
       ↳ com.kinvey.java.AbstractClient<T extends com.kinvey.java.dto.BaseUser>
         ↳ com.kinvey.nativejava.Client

Class Overview

Summary

Nested Classes
class Client.Builder Create a client for interacting with Kinvey's services from an Android Activity. 
[Expand]
Inherited Constants
From class com.kinvey.java.AbstractClient
[Expand]
Inherited Fields
From class com.kinvey.java.AbstractClient
Protected Constructors
Client(HttpTransport transport, HttpRequestInitializer httpRequestInitializer, String rootUrl, String servicePath, JsonObjectParser objectParser, KinveyClientRequestInitializer kinveyRequestInitializer, CredentialStore store, BackOffPolicy requestPolicy)
Private constructor.
Public Methods
<T extends GenericJson> NetworkManager<T> appData(String collectionName, Class<T> myClass)
NetworkManager factory method

Returns an instance of NetworkManager for the supplied collection.

CustomEndpoints customEndpoints(Class myClass)
BaseUser getActiveUser()
ICacheManager getCacheManager()
ClientUser getClientUser()
String getDeviceId()
String getFileCacheFolder()
void performLockDown()
boolean ping()
Asynchronous Ping service method

Performs an authenticated ping against the configured Kinvey backend.

void setActiveUser(BaseUser user)
UserDiscovery userDiscovery()
UserDiscovery factory method

Returns the instance of com.kinvey.java.UserDiscovery used for searching for users.

UserGroup userGroup()
UserGroup factory method

Returns the instance of com.kinvey.java.UserGroup used for managing user groups.

Protected Methods
ICacheManager getSyncCacheManager()
[Expand]
Inherited Methods
From class com.kinvey.java.AbstractClient
From class com.kinvey.java.core.AbstractKinveyJsonClient
From class com.kinvey.java.core.AbstractKinveyClient
From class java.lang.Object

Protected Constructors

protected Client (HttpTransport transport, HttpRequestInitializer httpRequestInitializer, String rootUrl, String servicePath, JsonObjectParser objectParser, KinveyClientRequestInitializer kinveyRequestInitializer, CredentialStore store, BackOffPolicy requestPolicy)

Private constructor. Use AbstractClient.Builder to initialize the AbstractClient.

Parameters
transport HttpTransport
httpRequestInitializer HttpRequestInitializer
rootUrl Root URL of service
servicePath path of Service
objectParser JsonObjectParser
kinveyRequestInitializer KinveyRequestInitializer
requestPolicy BackoffPolicy

Public Methods

public NetworkManager<T> appData (String collectionName, Class<T> myClass)

NetworkManager factory method

Returns an instance of NetworkManager for the supplied collection. A new instance is created for each collection, but only one instance of NetworkManager is created per collection. The method is Generic and takes an instance of a com.google.api.client.json.GenericJson entity type that is used for fetching/saving of NetworkManager.

This method is thread-safe.

Sample Usage: 

 NetworkManager<myEntity> myAppData = kinveyClient.appData("entityCollection", myEntity.class);

Parameters
collectionName The name of the collection
myClass The class that defines the entity of type com.google.api.client.json.GenericJson used for saving and fetching of data
Returns

public CustomEndpoints customEndpoints (Class myClass)

public BaseUser getActiveUser ()

public ICacheManager getCacheManager ()

public ClientUser getClientUser ()

public String getDeviceId ()

public String getFileCacheFolder ()

public void performLockDown ()

public boolean ping ()

Asynchronous Ping service method

Performs an authenticated ping against the configured Kinvey backend.

Sample Usage: 

     boolean ping = kinveyClient.ping().execute();

Returns
  • true if ping is successful, false if it fails
Throws
IOException

public void setActiveUser (BaseUser user)

public UserDiscovery userDiscovery ()

UserDiscovery factory method

Returns the instance of com.kinvey.java.UserDiscovery used for searching for users. Only one instance of UserDiscovery is created for each instance of the Kinvey Client.

This method is thread-safe.

Sample Usage: 

     UserDiscovery myUserDiscovery = kinveyClient.userDiscovery();

Returns
  • Instance of com.kinvey.java.UserDiscovery for the defined collection

public UserGroup userGroup ()

UserGroup factory method

Returns the instance of com.kinvey.java.UserGroup used for managing user groups. Only one instance of UserGroup is created for each instance of the Kinvey Client.

This method is thread-safe.

Sample Usage: 

     UserGroup myUserGroup = kinveyClient.userGroup();

Returns
  • Instance of com.kinvey.java.UserGroup for the defined collection

Protected Methods

protected ICacheManager getSyncCacheManager ()