com.appdirect.sdk.appmarket.events

Class APIResult

java.lang.Object

com.appdirect.sdk.appmarket.events.APIResult

public class APIResult
extends Object

The payload that is sent back to the AppMarket in response to an event

Constructor Summary

Constructors

Constructor and Description
APIResult(boolean success, String message)
APIResult(ErrorCode errorCode, String message)

Method Summary

Modifier and Type	Method and Description
static APIResult	asyncEventResult(String message)
static APIResult	failure(ErrorCode errorCode, String message) Creates a failed result with the given error code and message.
static APIResult	failure(int errorCode, String message)
static APIResult	success(String message)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIResult

public APIResult(ErrorCode errorCode,
                 String message)

APIResult

public APIResult(boolean success,
                 String message)

Method Detail

success

public static APIResult success(String message)

asyncEventResult

public static APIResult asyncEventResult(String message)

failure

public static APIResult failure(ErrorCode errorCode,
                                String message)

Creates a failed result with the given error code and message. Note: HTTP OK (200) will be returned to the appmarket; all responses going to the appmarket need to have a 200 status, whether they are successful or not.

Parameters:

errorCode - the code of the error

message - human-readable error message that explains the issue.

Returns:

the failed result object

failure

public static APIResult failure(int errorCode,
                                String message)