com.shopify.buy3

Class Storefront.CheckoutUserError

java.lang.Object

com.shopify.graphql.support.AbstractResponse<Storefront.CheckoutUserError>

com.shopify.buy3.Storefront.CheckoutUserError

All Implemented Interfaces:

Storefront.DisplayableError, java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.CheckoutUserError
extends AbstractResponse<Storefront.CheckoutUserError>
implements Storefront.DisplayableError

Represents an error that happens during execution of a checkout mutation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractResponse

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
CheckoutUserError()
CheckoutUserError(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
Storefront.CheckoutErrorCode	getCode() The error code.
java.util.List<java.lang.String>	getField() The path to the input field that caused the error.
java.lang.String	getGraphQlTypeName()
java.lang.String	getMessage() The error message.
Storefront.CheckoutUserError	setCode(Storefront.CheckoutErrorCode arg)
Storefront.CheckoutUserError	setField(java.util.List<java.lang.String> arg)
Storefront.CheckoutUserError	setMessage(java.lang.String arg)
boolean	unwrapsToObject(java.lang.String key)

Methods inherited from class com.shopify.graphql.support.AbstractResponse

collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckoutUserError

public CheckoutUserError()

CheckoutUserError

public CheckoutUserError(JsonObject fields)
                  throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.DisplayableError

getCode

public Storefront.CheckoutErrorCode getCode()

The error code.

setCode

public Storefront.CheckoutUserError setCode(Storefront.CheckoutErrorCode arg)

getField

public java.util.List<java.lang.String> getField()

The path to the input field that caused the error.

Specified by:

getField in interface Storefront.DisplayableError

setField

public Storefront.CheckoutUserError setField(java.util.List<java.lang.String> arg)

getMessage

public java.lang.String getMessage()

The error message.

Specified by:

getMessage in interface Storefront.DisplayableError

setMessage

public Storefront.CheckoutUserError setMessage(java.lang.String arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.CheckoutUserError>