public abstract class

AbstractClient

extends AbstractKinveyJsonClient
java.lang.Object
   ↳ com.kinvey.java.core.AbstractKinveyClient
     ↳ com.kinvey.java.core.AbstractKinveyJsonClient
       ↳ com.kinvey.java.AbstractClient

Class Overview

The core Kinvey client used to access Kinvey's BaaS. All factory methods for retrieving instances of a Service API are threadsafe, however the builder is not.

Summary

Nested Classes
class AbstractClient.Builder Builder class for AppdataKinveyClient. 
Constants
String DEFAULT_BASE_URL The default encoded root URL of the service.
String DEFAULT_SERVICE_PATH The default encoded service path of the service.
Public Methods
abstract <T> AppData<T> appData(String collectionName, Class<T> myClass)
void clearCustomRequestProperties()
abstract <I, O> CustomEndpoints<I, O> customEndpoints(Class<O> myClass)
void disableDebugLogging()
Disable logging for the HttpTransport class to Level.FINEST.
void enableDebugLogging()
Add logging for the HttpTransport class to Level.FINEST.
abstract File file()
Access to the File service where files of all sizes including images and videos can be uploaded and downloaded.
String getClientAppVersion()
GenericData getCustomRequestProperties()
ArrayList<ClientExtension> getExtensions()
CredentialStore getStore()
Class getUserClass()
void initializeRequest(AbstractKinveyClientRequest<?> httpClientRequest)
Initializes the Kinvey client request.
boolean pingBlocking()
Pings the Kinvey backend service with a logged in user.
Query query()
void registerExtension(ClientExtension extension)
void setClientAppVersion(String appVersion)
void setClientAppVersion(int major, int minor, int revision)
void setCustomRequestProperties(GenericJson customheaders)
void setCustomRequestProperty(String key, Object value)
void setUserClass(Class userClass)
<T extends User> User<T> user()
abstract UserDiscovery userDiscovery()
abstract UserGroup userGroup()
[Expand]
Inherited Methods
From class com.kinvey.java.core.AbstractKinveyJsonClient
From class com.kinvey.java.core.AbstractKinveyClient
From class java.lang.Object

Constants

public static final String DEFAULT_BASE_URL

The default encoded root URL of the service.

Constant Value: "https://baas.kinvey.com/"

public static final String DEFAULT_SERVICE_PATH

The default encoded service path of the service.

Constant Value: ""

Public Methods

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

Returns
  • a new instance of the AppData class

public void clearCustomRequestProperties ()

public abstract CustomEndpoints<I, O> customEndpoints (Class<O> myClass)

public void disableDebugLogging ()

Disable logging for the HttpTransport class to Level.FINEST.

public void enableDebugLogging ()

Add logging for the HttpTransport class to Level.FINEST.

Request and response log messages will be dumped to LogCat.

public abstract File file ()

Access to the File service where files of all sizes including images and videos can be uploaded and downloaded.

Returns
  • a new instance of File api wrapper

public String getClientAppVersion ()

public GenericData getCustomRequestProperties ()

public ArrayList<ClientExtension> getExtensions ()

public CredentialStore getStore ()

public Class getUserClass ()

public void initializeRequest (AbstractKinveyClientRequest<?> httpClientRequest)

Initializes the Kinvey client request. This method is only used internally to the library.

Throws
IOException

public boolean pingBlocking ()

Pings the Kinvey backend service with a logged in user.

Returns
  • true if service is reachable and user is logged in, false if not
Throws
IOException

public Query query ()

public void registerExtension (ClientExtension extension)

public void setClientAppVersion (String appVersion)

public void setClientAppVersion (int major, int minor, int revision)

public void setCustomRequestProperties (GenericJson customheaders)

public void setCustomRequestProperty (String key, Object value)

public void setUserClass (Class userClass)

public User<T> user ()

public abstract UserDiscovery userDiscovery ()

public abstract UserGroup userGroup ()