Shopify SDK for Unity
Public Member Functions | List of all members
Shopify.Unity.GraphQL.QueryRootQuery Class Reference

QueryRootQuery is the root query builder. All Storefront API queries are built off of QueryRootQuery. More...

Public Member Functions

 QueryRootQuery ()
 QueryRootQuery constructor accepts no parameters but it will create a root query builder. More...
 
QueryRootQuery articles (ArticleConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, ArticleSortKeys? sortKey=null, string queryValue=null, string alias=null)
 List of the shop's articles. More...
 
QueryRootQuery blogByHandle (BlogDelegate buildQuery, string handle, string alias=null)
 Find a blog by its handle. More...
 
QueryRootQuery blogs (BlogConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, BlogSortKeys? sortKey=null, string queryValue=null, string alias=null)
 List of the shop's blogs. More...
 
QueryRootQuery collectionByHandle (CollectionDelegate buildQuery, string handle, string alias=null)
 Find a collection by its handle. More...
 
QueryRootQuery collections (CollectionConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, CollectionSortKeys? sortKey=null, string queryValue=null, string alias=null)
 List of the shop’s collections. More...
 
QueryRootQuery customer (CustomerDelegate buildQuery, string customerAccessToken, string alias=null)
 Find a customer by its access token. More...
 
QueryRootQuery node (NodeDelegate buildQuery, string id, string alias=null)
 Returns a specific node by ID. More...
 
QueryRootQuery nodes (NodeDelegate buildQuery, List< string > ids, string alias=null)
 Returns the list of nodes with the given IDs. More...
 
QueryRootQuery pageByHandle (PageDelegate buildQuery, string handle, string alias=null)
 Find a page by its handle. More...
 
QueryRootQuery pages (PageConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, PageSortKeys? sortKey=null, string queryValue=null, string alias=null)
 List of the shop's pages. More...
 
QueryRootQuery productByHandle (ProductDelegate buildQuery, string handle, string alias=null)
 Find a product by its handle. More...
 
QueryRootQuery productRecommendations (ProductDelegate buildQuery, string productId, string alias=null)
 Find recommended products related to a given product_id. To learn more about how recommendations are generated, see Showing product recommendations on product pages. More...
 
QueryRootQuery productTags (StringConnectionDelegate buildQuery, long first, string alias=null)
 Tags added to products. Additional access scope required: unauthenticated_read_product_tags. More...
 
QueryRootQuery productTypes (StringConnectionDelegate buildQuery, long first, string alias=null)
 List of product types for the shop's products that are published to your app. More...
 
QueryRootQuery products (ProductConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, ProductSortKeys? sortKey=null, string queryValue=null, string alias=null)
 List of the shop’s products. More...
 
QueryRootQuery publicApiVersions (ApiVersionDelegate buildQuery)
 The list of public Storefront API versions, including supported, release candidate and unstable versions. More...
 
QueryRootQuery shop (ShopDelegate buildQuery)
 The shop associated with the storefront access token. More...
 
override string ToString ()
 Will return a GraphQL query. More...
 

Detailed Description

QueryRootQuery is the root query builder. All Storefront API queries are built off of QueryRootQuery.

Constructor & Destructor Documentation

◆ QueryRootQuery()

Shopify.Unity.GraphQL.QueryRootQuery.QueryRootQuery ( )
inline

QueryRootQuery constructor accepts no parameters but it will create a root query builder.

Member Function Documentation

◆ articles()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.articles ( ArticleConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
ArticleSortKeys sortKey = null,
string  queryValue = null,
string  alias = null 
)
inline

List of the shop's articles.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.
sortKeySort the underlying list by the given key.
querySupported filter parameters:
  • author
  • blog_title
  • created_at
  • tag
  • updated_at

See the detailed search syntax for more information about using filters.

◆ blogByHandle()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.blogByHandle ( BlogDelegate  buildQuery,
string  handle,
string  alias = null 
)
inline

Find a blog by its handle.

Parameters
handleThe handle of the blog.

◆ blogs()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.blogs ( BlogConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
BlogSortKeys sortKey = null,
string  queryValue = null,
string  alias = null 
)
inline

List of the shop's blogs.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.
sortKeySort the underlying list by the given key.
querySupported filter parameters:
  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax for more information about using filters.

◆ collectionByHandle()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.collectionByHandle ( CollectionDelegate  buildQuery,
string  handle,
string  alias = null 
)
inline

Find a collection by its handle.

Parameters
handleThe handle of the collection.

◆ collections()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.collections ( CollectionConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
CollectionSortKeys sortKey = null,
string  queryValue = null,
string  alias = null 
)
inline

List of the shop’s collections.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.
sortKeySort the underlying list by the given key.
querySupported filter parameters:
  • collection_type
  • title
  • updated_at

See the detailed search syntax for more information about using filters.

◆ customer()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.customer ( CustomerDelegate  buildQuery,
string  customerAccessToken,
string  alias = null 
)
inline

Find a customer by its access token.

Parameters
customerAccessTokenThe customer access token.

◆ node()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.node ( NodeDelegate  buildQuery,
string  id,
string  alias = null 
)
inline

Returns a specific node by ID.

Parameters
idThe ID of the Node to return.

◆ nodes()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.nodes ( NodeDelegate  buildQuery,
List< string >  ids,
string  alias = null 
)
inline

Returns the list of nodes with the given IDs.

Parameters
idsThe IDs of the Nodes to return.

◆ pageByHandle()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.pageByHandle ( PageDelegate  buildQuery,
string  handle,
string  alias = null 
)
inline

Find a page by its handle.

Parameters
handleThe handle of the page.

◆ pages()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.pages ( PageConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
PageSortKeys sortKey = null,
string  queryValue = null,
string  alias = null 
)
inline

List of the shop's pages.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.
sortKeySort the underlying list by the given key.
querySupported filter parameters:
  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax for more information about using filters.

◆ productByHandle()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.productByHandle ( ProductDelegate  buildQuery,
string  handle,
string  alias = null 
)
inline

Find a product by its handle.

Parameters
handleThe handle of the product.

◆ productRecommendations()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.productRecommendations ( ProductDelegate  buildQuery,
string  productId,
string  alias = null 
)
inline

Find recommended products related to a given product_id. To learn more about how recommendations are generated, see Showing product recommendations on product pages.

Parameters
productIdThe id of the product.

◆ products()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.products ( ProductConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
ProductSortKeys sortKey = null,
string  queryValue = null,
string  alias = null 
)
inline

List of the shop’s products.

Parameters
firstReturns up to the first n elements from the list.
afterReturns the elements that come after the specified cursor.
lastReturns up to the last n elements from the list.
beforeReturns the elements that come before the specified cursor.
reverseReverse the order of the underlying list.
sortKeySort the underlying list by the given key.
querySupported filter parameters:
  • available_for_sale
  • created_at
  • product_type
  • tag
  • title
  • updated_at
  • variants.price
  • vendor

See the detailed search syntax for more information about using filters.

◆ productTags()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.productTags ( StringConnectionDelegate  buildQuery,
long  first,
string  alias = null 
)
inline

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

Parameters
firstReturns up to the first n elements from the list.

◆ productTypes()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.productTypes ( StringConnectionDelegate  buildQuery,
long  first,
string  alias = null 
)
inline

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

Parameters
firstReturns up to the first n elements from the list.

◆ publicApiVersions()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.publicApiVersions ( ApiVersionDelegate  buildQuery)
inline

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

◆ shop()

QueryRootQuery Shopify.Unity.GraphQL.QueryRootQuery.shop ( ShopDelegate  buildQuery)
inline

The shop associated with the storefront access token.

◆ ToString()

override string Shopify.Unity.GraphQL.QueryRootQuery.ToString ( )
inline

Will return a GraphQL query.


The documentation for this class was generated from the following file: