com.urbanairship.api.push.model

Class PushResponse

java.lang.Object

com.urbanairship.api.push.model.PushResponse

public final class PushResponse
extends java.lang.Object

Represents a response from the Urban Airship API for Push Notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushResponse.Builder PushResponse Builder

Constructor Summary

Constructors

Constructor and Description
PushResponse(java.lang.String operationId, <any> pushIds, boolean ok, <any> messageIds, <any> contentUrls, <any> localizedIds, java.lang.String error, ErrorDetails errorDetails)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<<any>>	getContentUrls()
java.util.Optional<java.lang.String>	getError() Get the error if present
java.util.Optional<ErrorDetails>	getErrorDetails() Get the error details if present
java.util.Optional<<any>>	getLocalizedIds()
java.util.Optional<<any>>	getMessageIds()
boolean	getOk() Get the response status as a boolean
java.util.Optional<java.lang.String>	getOperationId() Get the operation id for this response.
java.util.Optional<<any>>	getPushIds() List of push id's, one for every actual push message that moves through the API.
int	hashCode()
static PushResponse.Builder	newBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PushResponse

public PushResponse(java.lang.String operationId,
                    <any> pushIds,
                    boolean ok,
                    <any> messageIds,
                    <any> contentUrls,
                    <any> localizedIds,
                    java.lang.String error,
                    ErrorDetails errorDetails)

Method Detail

newBuilder

public static PushResponse.Builder newBuilder()

getOperationId

public java.util.Optional<java.lang.String> getOperationId()

Get the operation id for this response. This is used by Urban Airship to track an operation through our system, and should be used when support is needed.

Returns:

Operation id for this API request

getPushIds

public java.util.Optional<<any>> getPushIds()

List of push id's, one for every actual push message that moves through the API. This is useful for tracking an individual message as part of an operation, and can be used when support is needed.

Returns:

List of push ids.

getOk

public boolean getOk()

Get the response status as a boolean

Returns:

Response status

getMessageIds

public java.util.Optional<<any>> getMessageIds()

getContentUrls

public java.util.Optional<<any>> getContentUrls()

getLocalizedIds

public java.util.Optional<<any>> getLocalizedIds()

getError

public java.util.Optional<java.lang.String> getError()

Get the error if present

Returns:

An Optional String

getErrorDetails

public java.util.Optional<ErrorDetails> getErrorDetails()

Get the error details if present

Returns:

An Optional String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object