Package com.mparticle.identity

Class AliasResponse

java.lang.Object

com.mparticle.identity.AliasResponse

public class AliasResponse
extends java.lang.Object

Object describing the results of the most recent Alias request, including success indicators, and any error messages.

Constructor Summary

Constructors

Constructor	Description
AliasResponse(com.mparticle.internal.MParticleApiClient.AliasNetworkResponse response, AliasRequest originalRequst, java.lang.String requestId, boolean willRetry)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getErrorResponse()	The error response message returned by the server, if there was one
AliasRequest	getRequest()	A copy of the AliasRequest object passed into IdentityApi.aliasUsers(AliasRequest) that this AliasResponse is describing
java.lang.String	getRequestId()	The internal ID for the Alias request.
int	getResponseCode()	The HTTP response code for the Alias network request
boolean	isSuccessful()	Whether or not the request was successful
boolean	willRetry()	Whether or not this request will be retried.

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasResponse

public AliasResponse(@NonNull
                     com.mparticle.internal.MParticleApiClient.AliasNetworkResponse response,
                     @NonNull
                     AliasRequest originalRequst,
                     @NonNull
                     java.lang.String requestId,
                     boolean willRetry)

Method Detail

getResponseCode

public int getResponseCode()

The HTTP response code for the Alias network request

Returns:

getRequestId

@NonNull
public java.lang.String getRequestId()

The internal ID for the Alias request. Each AliasRequest has a unique, consistent request id

Returns:

getRequest

@NonNull
public AliasRequest getRequest()

A copy of the AliasRequest object passed into IdentityApi.aliasUsers(AliasRequest) that this AliasResponse is describing

Returns:

isSuccessful

public boolean isSuccessful()

Whether or not the request was successful

Returns:

willRetry

public boolean willRetry()

Whether or not this request will be retried. Retries are handled by the SDK, so this does not indicate that any action needs to be taken. Requests that result in recoverable errors, such as rate limiting server error will be retried, while authentication errors, malformed requests and others will not be retried

Returns:

getErrorResponse

@Nullable
public java.lang.String getErrorResponse()

The error response message returned by the server, if there was one

Returns: