com.gigya.android.sdk.api

Class GigyaApiResponse

java.lang.Object

com.gigya.android.sdk.api.GigyaApiResponse

public class GigyaApiResponse
extends java.lang.Object

Gigya generic response class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_VALUE
static int	OK

Constructor Summary

Constructors

Constructor and Description
GigyaApiResponse(java.lang.String json)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asJson() Get JSON formatted of the current response.
boolean	contains(java.lang.String key) Check if response parameters contains a specific key.
boolean	containsNested(java.lang.String key) Check if response parameters contains a specific nested key.
java.lang.String	getCallId() Get response callId.
int	getErrorCode() Get response error code.
java.lang.String	getErrorDetails() Get response error details if exists.
<T> T	getField(java.lang.String key, java.lang.Class<T> clazz) Type field optional getter.
Gson	getGson()
int	getStatusCode() Get response status code
java.lang.String	getStatusReason() Get response status reason if exists.
java.lang.String	getTime() Get response time.
<T> T	parseTo(java.lang.Class<T> clazz) Optional parsing of the current response with generic given type.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_VALUE

public static final int INVALID_VALUE

See Also:

Constant Field Values

OK

public static final int OK

See Also:

Constant Field Values

Constructor Detail

GigyaApiResponse

public GigyaApiResponse(java.lang.String json)

Method Detail

getGson

public Gson getGson()

asJson

public java.lang.String asJson()

Get JSON formatted of the current response.

Returns:

JSON formatted String.

parseTo

public <T> T parseTo(java.lang.Class<T> clazz)

Optional parsing of the current response with generic given type. Uses GSON as the parsing engine.

Parameters:

clazz - Requested type for parsing.

Returns:

Parsed hard copy class according to provided type.

contains

public boolean contains(java.lang.String key)

Check if response parameters contains a specific key.

Parameters:

key - Required key for evaluation.

Returns:

TRUE of key is present.

containsNested

public boolean containsNested(java.lang.String key)

Check if response parameters contains a specific nested key. Nested key example: profile.firstName

Parameters:

key - Required key for evaluation.

Returns:

TRUE of nested key is present.

getField

public <T> T getField(java.lang.String key,
                      java.lang.Class<T> clazz)

Type field optional getter. Allows fetching an parsed object from response parameters given required type. Uses GSON as the parsing engine.

Parameters:

key - Requested parameter key.

clazz - Required parsed object type.

Returns:

Parsed hard copy class according to provided key and type.

getStatusCode

public int getStatusCode()

Get response status code

Returns:

Integer status code.

getErrorCode

public int getErrorCode()

Get response error code.

Returns:

Integer error code.

getErrorDetails

public java.lang.String getErrorDetails()

Get response error details if exists.

Returns:

String error details.

getStatusReason

public java.lang.String getStatusReason()

Get response status reason if exists.

Returns:

String status reason.

getCallId

public java.lang.String getCallId()

Get response callId.

Returns:

String callId.

getTime

public java.lang.String getTime()

Get response time.

Returns:

String formatted timestamp.