lithium.community.android.sdk.api

Class LiBaseGetClient

java.lang.Object

lithium.community.android.sdk.api.LiBaseGetClient

All Implemented Interfaces:

LiClient

public class LiBaseGetClient
extends java.lang.Object

All "get" clients are implemented in same way. They only vary in their TYPE and LIQL query. This class brings all the common codes together and provide a layer of abstraction to all of the "get" clients. Created by kunal.shrivastava on 10/19/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	lithium.community.android.sdk.api.LiBaseClient.RequestType Enum to classify Request Type

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	basePath
protected android.content.Context	context
protected LiQueryOrdering	liQueryOrdering
protected LiRestV2Request	liRestV2Request
protected java.lang.String	querySettingsType
protected lithium.community.android.sdk.api.LiBaseClient.RequestType	requestType
protected java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
LiBaseGetClient(android.content.Context context, java.lang.String activityLIQL, java.lang.String type, java.lang.Class<? extends LiBaseModel> responseClass, LiQueryRequestParams liQueryRequestParams)
LiBaseGetClient(android.content.Context context, java.lang.String activityLIQL, java.lang.String type, java.lang.String querySettingsType, java.lang.Class<? extends LiBaseModel> responseClass)
LiBaseGetClient(android.content.Context context, java.lang.String activityLIQL, java.lang.String type, java.lang.String querySettingsType, java.lang.Class<? extends LiBaseModel> responseClass, java.lang.String pathParam)

Method Summary

Modifier and Type	Method and Description
Gson	getGson() Fetches Gson from LiRestv2Client LiClient.getGson()
protected java.lang.String	getLiqlQuery() Method to return LIQL query for a particular client based on client type and base query.
java.lang.String	getRequestBody() Request body is always null for GET Client.
lithium.community.android.sdk.api.LiBaseClient.RequestType	getRequestType() Method to get Request Type
java.lang.String	getType() Returns type i.e whether message, image, kudo etc..
void	processAsync(LiAsyncRequestCallback liAsyncRequestCallback) This method is for making an async network call.
void	processAsync(LiAsyncRequestCallback liAsyncRequestCallback, java.lang.String imagePath, java.lang.String imageName) processSync call to upload files
LiClientResponse	processSync() This method is for making a sync network call.
void	setLiRestV2Request() Initialize LiRestV2Request with LIQL and type.
LiClient	setOrdering(LiQueryOrdering liQueryOrdering) Use to set liQueryOrdering in LIQL if any
LiClient	setReplacer(LiQueryValueReplacer liQueryValueReplacer) Method to add liQueryValueReplacer to replace special characters with actual values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

protected final java.lang.String type

querySettingsType

protected java.lang.String querySettingsType

context

protected android.content.Context context

liRestV2Request

protected LiRestV2Request liRestV2Request

basePath

protected java.lang.String basePath

requestType

protected lithium.community.android.sdk.api.LiBaseClient.RequestType requestType

liQueryOrdering

protected LiQueryOrdering liQueryOrdering

Constructor Detail

LiBaseGetClient

public LiBaseGetClient(android.content.Context context,
                       java.lang.String activityLIQL,
                       java.lang.String type,
                       java.lang.String querySettingsType,
                       java.lang.Class<? extends LiBaseModel> responseClass)
                throws LiRestResponseException

Throws:

LiRestResponseException

LiBaseGetClient

public LiBaseGetClient(android.content.Context context,
                       java.lang.String activityLIQL,
                       java.lang.String type,
                       java.lang.String querySettingsType,
                       java.lang.Class<? extends LiBaseModel> responseClass,
                       java.lang.String pathParam)
                throws LiRestResponseException

Throws:

LiRestResponseException

LiBaseGetClient

public LiBaseGetClient(android.content.Context context,
                       java.lang.String activityLIQL,
                       java.lang.String type,
                       java.lang.Class<? extends LiBaseModel> responseClass,
                       LiQueryRequestParams liQueryRequestParams)

Method Detail

setLiRestV2Request

public void setLiRestV2Request()

Initialize LiRestV2Request with LIQL and type. LiBaseClient.setLiRestV2Request()

getRequestBody

public java.lang.String getRequestBody()

Request body is always null for GET Client.

Returns:

null

getLiqlQuery

protected java.lang.String getLiqlQuery()

Method to return LIQL query for a particular client based on client type and base query.

Returns:

Complete query.

setReplacer

public LiClient setReplacer(LiQueryValueReplacer liQueryValueReplacer)

Method to add liQueryValueReplacer to replace special characters with actual values

Parameters:

liQueryValueReplacer - LiQueryValueReplacer

Returns:

this

processAsync

public void processAsync(LiAsyncRequestCallback liAsyncRequestCallback)
                  throws LiRestResponseException

This method is for making an async network call. LiClient.processAsync(LiAsyncRequestCallback)

Specified by:

processAsync in interface LiClient

Parameters:

liAsyncRequestCallback - LiAsyncRequestCallback

Throws:

LiRestResponseException

processAsync

public void processAsync(LiAsyncRequestCallback liAsyncRequestCallback,
                         java.lang.String imagePath,
                         java.lang.String imageName)
                  throws LiRestResponseException

processSync call to upload files

Specified by:

processAsync in interface LiClient

Parameters:

liAsyncRequestCallback - LiAsyncRequestCallback

imagePath - this is the absolute path of the image.

imageName - this is the name of the image file.

Throws:

LiRestResponseException

processSync

public LiClientResponse processSync()
                             throws LiRestResponseException

This method is for making a sync network call. LiClient.processSync()

Specified by:

processSync in interface LiClient

Returns:

LiBaseResponse This is OkHttp reponse wrapped into LiBaseResponse.

Throws:

LiRestResponseException

getGson

public Gson getGson()

Fetches Gson from LiRestv2Client LiClient.getGson()

Specified by:

getGson in interface LiClient

Returns:

Gson object

getType

public java.lang.String getType()

Returns type i.e whether message, image, kudo etc..

Specified by:

getType in interface LiClient

Returns:

String depicting type.

getRequestType

public lithium.community.android.sdk.api.LiBaseClient.RequestType getRequestType()

Description copied from interface: LiClient

Method to get Request Type

Specified by:

getRequestType in interface LiClient

Returns:

RequestType whether GET, POST, DELETE, PUT.

setOrdering

public LiClient setOrdering(LiQueryOrdering liQueryOrdering)

Use to set liQueryOrdering in LIQL if any

Specified by:

setOrdering in interface LiClient

Parameters:

liQueryOrdering - LiQueryOrdering