com.shopify.buy3

Class Storefront.MailingAddress

java.lang.Object

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

com.shopify.buy3.Storefront.MailingAddress

All Implemented Interfaces:

Storefront.DeliveryAddress, Storefront.Node, Node, java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.MailingAddress
extends AbstractResponse<Storefront.MailingAddress>
implements Storefront.DeliveryAddress, Storefront.Node

Represents a mailing address for customers and shipping.

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
MailingAddress()
MailingAddress(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress1() The first line of the address.
java.lang.String	getAddress2() The second line of the address.
java.lang.String	getCity() The name of the city, district, village, or town.
java.lang.String	getCompany() The name of the customer's company or organization.
java.lang.String	getCountry() The name of the country.
java.lang.String	getCountryCode() Deprecated. Use `countryCodeV2` instead.
Storefront.CountryCode	getCountryCodeV2() The two-letter code for the country of the address.
java.lang.String	getFirstName() The first name of the customer.
java.util.List<java.lang.String>	getFormatted() A formatted version of the address, customized by the provided arguments.
java.lang.String	getFormattedArea() A comma-separated list of the values for city, province, and country.
java.lang.String	getGraphQlTypeName()
ID	getId() A globally-unique ID.
java.lang.String	getLastName() The last name of the customer.
java.lang.Double	getLatitude() The latitude coordinate of the customer address.
java.lang.Double	getLongitude() The longitude coordinate of the customer address.
java.lang.String	getName() The full name of the customer, based on firstName and lastName.
java.lang.String	getPhone() A unique phone number for the customer.
java.lang.String	getProvince() The region of the address, such as the province, state, or district.
java.lang.String	getProvinceCode() The alphanumeric code for the region.
java.lang.String	getZip() The zip or postal code of the address.
Storefront.MailingAddress	setAddress1(java.lang.String arg)
Storefront.MailingAddress	setAddress2(java.lang.String arg)
Storefront.MailingAddress	setCity(java.lang.String arg)
Storefront.MailingAddress	setCompany(java.lang.String arg)
Storefront.MailingAddress	setCountry(java.lang.String arg)
Storefront.MailingAddress	setCountryCode(java.lang.String arg)
Storefront.MailingAddress	setCountryCodeV2(Storefront.CountryCode arg)
Storefront.MailingAddress	setFirstName(java.lang.String arg)
Storefront.MailingAddress	setFormatted(java.util.List<java.lang.String> arg)
Storefront.MailingAddress	setFormattedArea(java.lang.String arg)
Storefront.MailingAddress	setLastName(java.lang.String arg)
Storefront.MailingAddress	setLatitude(java.lang.Double arg)
Storefront.MailingAddress	setLongitude(java.lang.Double arg)
Storefront.MailingAddress	setName(java.lang.String arg)
Storefront.MailingAddress	setPhone(java.lang.String arg)
Storefront.MailingAddress	setProvince(java.lang.String arg)
Storefront.MailingAddress	setProvinceCode(java.lang.String arg)
Storefront.MailingAddress	setZip(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

MailingAddress

public MailingAddress()

MailingAddress

public MailingAddress(JsonObject fields)
               throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.DeliveryAddress

Specified by:

getGraphQlTypeName in interface Storefront.Node

Specified by:

getGraphQlTypeName in interface Node

getAddress1

public java.lang.String getAddress1()

The first line of the address. Typically the street address or PO Box number.

setAddress1

public Storefront.MailingAddress setAddress1(java.lang.String arg)

getAddress2

public java.lang.String getAddress2()

The second line of the address. Typically the number of the apartment, suite, or unit.

setAddress2

public Storefront.MailingAddress setAddress2(java.lang.String arg)

getCity

public java.lang.String getCity()

The name of the city, district, village, or town.

setCity

public Storefront.MailingAddress setCity(java.lang.String arg)

getCompany

public java.lang.String getCompany()

The name of the customer's company or organization.

setCompany

public Storefront.MailingAddress setCompany(java.lang.String arg)

getCountry

public java.lang.String getCountry()

The name of the country.

setCountry

public Storefront.MailingAddress setCountry(java.lang.String arg)

getCountryCode

public java.lang.String getCountryCode()

Deprecated. Use `countryCodeV2` instead.

The two-letter code for the country of the address. For example, US.

setCountryCode

public Storefront.MailingAddress setCountryCode(java.lang.String arg)

getCountryCodeV2

public Storefront.CountryCode getCountryCodeV2()

The two-letter code for the country of the address. For example, US.

setCountryCodeV2

public Storefront.MailingAddress setCountryCodeV2(Storefront.CountryCode arg)

getFirstName

public java.lang.String getFirstName()

The first name of the customer.

setFirstName

public Storefront.MailingAddress setFirstName(java.lang.String arg)

getFormatted

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

A formatted version of the address, customized by the provided arguments.

setFormatted

public Storefront.MailingAddress setFormatted(java.util.List<java.lang.String> arg)

getFormattedArea

public java.lang.String getFormattedArea()

A comma-separated list of the values for city, province, and country.

setFormattedArea

public Storefront.MailingAddress setFormattedArea(java.lang.String arg)

getId

public ID getId()

A globally-unique ID.

Specified by:

getId in interface Storefront.Node

Specified by:

getId in interface Node

getLastName

public java.lang.String getLastName()

The last name of the customer.

setLastName

public Storefront.MailingAddress setLastName(java.lang.String arg)

getLatitude

public java.lang.Double getLatitude()

The latitude coordinate of the customer address.

setLatitude

public Storefront.MailingAddress setLatitude(java.lang.Double arg)

getLongitude

public java.lang.Double getLongitude()

The longitude coordinate of the customer address.

setLongitude

public Storefront.MailingAddress setLongitude(java.lang.Double arg)

getName

public java.lang.String getName()

The full name of the customer, based on firstName and lastName.

setName

public Storefront.MailingAddress setName(java.lang.String arg)

getPhone

public java.lang.String getPhone()

A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_.

setPhone

public Storefront.MailingAddress setPhone(java.lang.String arg)

getProvince

public java.lang.String getProvince()

The region of the address, such as the province, state, or district.

setProvince

public Storefront.MailingAddress setProvince(java.lang.String arg)

getProvinceCode

public java.lang.String getProvinceCode()

The alphanumeric code for the region. For example, ON.

setProvinceCode

public Storefront.MailingAddress setProvinceCode(java.lang.String arg)

getZip

public java.lang.String getZip()

The zip or postal code of the address.

setZip

public Storefront.MailingAddress setZip(java.lang.String arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.MailingAddress>