com.shopify.buy3

Class Storefront.QueryRoot

java.lang.Object

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

com.shopify.buy3.Storefront.QueryRoot

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.QueryRoot
extends AbstractResponse<Storefront.QueryRoot>

The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
QueryRoot()
QueryRoot(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
Storefront.Article	getArticle() Fetch a specific Article by its ID.
Storefront.ArticleConnection	getArticles() List of the shop's articles.
Storefront.Blog	getBlog() Fetch a specific `Blog` by one of its unique attributes.
Storefront.Blog	getBlogByHandle() Deprecated. Use `blog` instead.
Storefront.BlogConnection	getBlogs() List of the shop's blogs.
Storefront.Cart	getCart() Retrieve a cart by its ID.
Storefront.CartCompletionAttemptResult	getCartCompletionAttempt() A poll for the status of the cart checkout completion and order creation.
Storefront.Collection	getCollection() Fetch a specific `Collection` by one of its unique attributes.
Storefront.Collection	getCollectionByHandle() Deprecated. Use `collection` instead.
Storefront.CollectionConnection	getCollections() List of the shop’s collections.
Storefront.Customer	getCustomer() The customer associated with the given access token.
java.lang.String	getGraphQlTypeName()
Storefront.Localization	getLocalization() Returns the localized experiences configured for the shop.
Storefront.LocationConnection	getLocations() List of the shop's locations that support in-store pickup.
Storefront.Menu	getMenu() Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle.
Storefront.Metaobject	getMetaobject() Fetch a specific Metaobject by one of its unique identifiers.
Storefront.MetaobjectConnection	getMetaobjects() All active metaobjects for the shop.
Storefront.Node	getNode() Returns a specific node by ID.
java.util.List<Storefront.Node>	getNodes() Returns the list of nodes with the given IDs.
Storefront.Page	getPage() Fetch a specific `Page` by one of its unique attributes.
Storefront.Page	getPageByHandle() Deprecated. Use `page` instead.
Storefront.PageConnection	getPages() List of the shop's pages.
Storefront.PredictiveSearchResult	getPredictiveSearch() List of the predictive search results.
Storefront.Product	getProduct() Fetch a specific `Product` by one of its unique attributes.
Storefront.Product	getProductByHandle() Deprecated. Use `product` instead.
java.util.List<Storefront.Product>	getProductRecommendations() Find recommended products related to a given `product_id`.
Storefront.ProductConnection	getProducts() List of the shop’s products.
Storefront.StringConnection	getProductTags() Tags added to products.
Storefront.StringConnection	getProductTypes() List of product types for the shop's products that are published to your app.
java.util.List<Storefront.ApiVersion>	getPublicApiVersions() The list of public Storefront API versions, including supported, release candidate and unstable versions.
Storefront.SearchResultItemConnection	getSearch() List of the search results.
Storefront.Shop	getShop() The shop associated with the storefront access token.
Storefront.UrlRedirectConnection	getUrlRedirects() A list of redirects for a shop.
Storefront.QueryRoot	setArticle(Storefront.Article arg)
Storefront.QueryRoot	setArticles(Storefront.ArticleConnection arg)
Storefront.QueryRoot	setBlog(Storefront.Blog arg)
Storefront.QueryRoot	setBlogByHandle(Storefront.Blog arg)
Storefront.QueryRoot	setBlogs(Storefront.BlogConnection arg)
Storefront.QueryRoot	setCart(Storefront.Cart arg)
Storefront.QueryRoot	setCartCompletionAttempt(Storefront.CartCompletionAttemptResult arg)
Storefront.QueryRoot	setCollection(Storefront.Collection arg)
Storefront.QueryRoot	setCollectionByHandle(Storefront.Collection arg)
Storefront.QueryRoot	setCollections(Storefront.CollectionConnection arg)
Storefront.QueryRoot	setCustomer(Storefront.Customer arg)
Storefront.QueryRoot	setLocalization(Storefront.Localization arg)
Storefront.QueryRoot	setLocations(Storefront.LocationConnection arg)
Storefront.QueryRoot	setMenu(Storefront.Menu arg)
Storefront.QueryRoot	setMetaobject(Storefront.Metaobject arg)
Storefront.QueryRoot	setMetaobjects(Storefront.MetaobjectConnection arg)
Storefront.QueryRoot	setNode(Storefront.Node arg)
Storefront.QueryRoot	setNodes(java.util.List<Storefront.Node> arg)
Storefront.QueryRoot	setPage(Storefront.Page arg)
Storefront.QueryRoot	setPageByHandle(Storefront.Page arg)
Storefront.QueryRoot	setPages(Storefront.PageConnection arg)
Storefront.QueryRoot	setPredictiveSearch(Storefront.PredictiveSearchResult arg)
Storefront.QueryRoot	setProduct(Storefront.Product arg)
Storefront.QueryRoot	setProductByHandle(Storefront.Product arg)
Storefront.QueryRoot	setProductRecommendations(java.util.List<Storefront.Product> arg)
Storefront.QueryRoot	setProducts(Storefront.ProductConnection arg)
Storefront.QueryRoot	setProductTags(Storefront.StringConnection arg)
Storefront.QueryRoot	setProductTypes(Storefront.StringConnection arg)
Storefront.QueryRoot	setPublicApiVersions(java.util.List<Storefront.ApiVersion> arg)
Storefront.QueryRoot	setSearch(Storefront.SearchResultItemConnection arg)
Storefront.QueryRoot	setShop(Storefront.Shop arg)
Storefront.QueryRoot	setUrlRedirects(Storefront.UrlRedirectConnection 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

QueryRoot

public QueryRoot()

QueryRoot

public QueryRoot(JsonObject fields)
          throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

getArticle

public Storefront.Article getArticle()

Fetch a specific Article by its ID.

setArticle

public Storefront.QueryRoot setArticle(Storefront.Article arg)

getArticles

public Storefront.ArticleConnection getArticles()

List of the shop's articles.

setArticles

public Storefront.QueryRoot setArticles(Storefront.ArticleConnection arg)

getBlog

public Storefront.Blog getBlog()

Fetch a specific `Blog` by one of its unique attributes.

setBlog

public Storefront.QueryRoot setBlog(Storefront.Blog arg)

getBlogByHandle

public Storefront.Blog getBlogByHandle()

Deprecated. Use `blog` instead.

Find a blog by its handle.

setBlogByHandle

public Storefront.QueryRoot setBlogByHandle(Storefront.Blog arg)

getBlogs

public Storefront.BlogConnection getBlogs()

List of the shop's blogs.

setBlogs

public Storefront.QueryRoot setBlogs(Storefront.BlogConnection arg)

getCart

public Storefront.Cart getCart()

Retrieve a cart by its ID. For more information, refer to [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage).

setCart

public Storefront.QueryRoot setCart(Storefront.Cart arg)

getCartCompletionAttempt

public Storefront.CartCompletionAttemptResult getCartCompletionAttempt()

A poll for the status of the cart checkout completion and order creation.

setCartCompletionAttempt

public Storefront.QueryRoot setCartCompletionAttempt(Storefront.CartCompletionAttemptResult arg)

getCollection

public Storefront.Collection getCollection()

Fetch a specific `Collection` by one of its unique attributes.

setCollection

public Storefront.QueryRoot setCollection(Storefront.Collection arg)

getCollectionByHandle

public Storefront.Collection getCollectionByHandle()

Deprecated. Use `collection` instead.

Find a collection by its handle.

setCollectionByHandle

public Storefront.QueryRoot setCollectionByHandle(Storefront.Collection arg)

getCollections

public Storefront.CollectionConnection getCollections()

List of the shop’s collections.

setCollections

public Storefront.QueryRoot setCollections(Storefront.CollectionConnection arg)

getCustomer

public Storefront.Customer getCustomer()

The customer associated with the given access token. Tokens are obtained by using the [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate).

setCustomer

public Storefront.QueryRoot setCustomer(Storefront.Customer arg)

getLocalization

public Storefront.Localization getLocalization()

Returns the localized experiences configured for the shop.

setLocalization

public Storefront.QueryRoot setLocalization(Storefront.Localization arg)

getLocations

public Storefront.LocationConnection getLocations()

List of the shop's locations that support in-store pickup. When sorting by distance, you must specify a location via the `near` argument.

setLocations

public Storefront.QueryRoot setLocations(Storefront.LocationConnection arg)

getMenu

public Storefront.Menu getMenu()

Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle.

setMenu

public Storefront.QueryRoot setMenu(Storefront.Menu arg)

getMetaobject

public Storefront.Metaobject getMetaobject()

Fetch a specific Metaobject by one of its unique identifiers.

setMetaobject

public Storefront.QueryRoot setMetaobject(Storefront.Metaobject arg)

getMetaobjects

public Storefront.MetaobjectConnection getMetaobjects()

All active metaobjects for the shop.

setMetaobjects

public Storefront.QueryRoot setMetaobjects(Storefront.MetaobjectConnection arg)

getNode

public Storefront.Node getNode()

Returns a specific node by ID.

setNode

public Storefront.QueryRoot setNode(Storefront.Node arg)

getNodes

public java.util.List<Storefront.Node> getNodes()

Returns the list of nodes with the given IDs.

setNodes

public Storefront.QueryRoot setNodes(java.util.List<Storefront.Node> arg)

getPage

public Storefront.Page getPage()

Fetch a specific `Page` by one of its unique attributes.

setPage

public Storefront.QueryRoot setPage(Storefront.Page arg)

getPageByHandle

public Storefront.Page getPageByHandle()

Deprecated. Use `page` instead.

Find a page by its handle.

setPageByHandle

public Storefront.QueryRoot setPageByHandle(Storefront.Page arg)

getPages

public Storefront.PageConnection getPages()

List of the shop's pages.

setPages

public Storefront.QueryRoot setPages(Storefront.PageConnection arg)

getPredictiveSearch

public Storefront.PredictiveSearchResult getPredictiveSearch()

List of the predictive search results.

setPredictiveSearch

public Storefront.QueryRoot setPredictiveSearch(Storefront.PredictiveSearchResult arg)

getProduct

public Storefront.Product getProduct()

Fetch a specific `Product` by one of its unique attributes.

setProduct

public Storefront.QueryRoot setProduct(Storefront.Product arg)

getProductByHandle

public Storefront.Product getProductByHandle()

Deprecated. Use `product` instead.

Find a product by its handle.

setProductByHandle

public Storefront.QueryRoot setProductByHandle(Storefront.Product arg)

getProductRecommendations

public java.util.List<Storefront.Product> getProductRecommendations()

Find recommended products related to a given `product_id`. To learn more about how recommendations are generated, see [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products).

setProductRecommendations

public Storefront.QueryRoot setProductRecommendations(java.util.List<Storefront.Product> arg)

getProductTags

public Storefront.StringConnection getProductTags()

Tags added to products. Additional access scope required: unauthenticated_read_product_tags.

setProductTags

public Storefront.QueryRoot setProductTags(Storefront.StringConnection arg)

getProductTypes

public Storefront.StringConnection getProductTypes()

List of product types for the shop's products that are published to your app.

setProductTypes

public Storefront.QueryRoot setProductTypes(Storefront.StringConnection arg)

getProducts

public Storefront.ProductConnection getProducts()

List of the shop’s products. For storefront search, use [`search` query](https://shopify.dev/docs/api/storefront/latest/queries/search).

setProducts

public Storefront.QueryRoot setProducts(Storefront.ProductConnection arg)

getPublicApiVersions

public java.util.List<Storefront.ApiVersion> getPublicApiVersions()

The list of public Storefront API versions, including supported, release candidate and unstable versions.

setPublicApiVersions

public Storefront.QueryRoot setPublicApiVersions(java.util.List<Storefront.ApiVersion> arg)

getSearch

public Storefront.SearchResultItemConnection getSearch()

List of the search results.

setSearch

public Storefront.QueryRoot setSearch(Storefront.SearchResultItemConnection arg)

getShop

public Storefront.Shop getShop()

The shop associated with the storefront access token.

setShop

public Storefront.QueryRoot setShop(Storefront.Shop arg)

getUrlRedirects

public Storefront.UrlRedirectConnection getUrlRedirects()

A list of redirects for a shop.

setUrlRedirects

public Storefront.QueryRoot setUrlRedirects(Storefront.UrlRedirectConnection arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.QueryRoot>