com.shopify.buy3

Class Storefront.CollectionQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.CollectionQuery>

com.shopify.buy3.Storefront.CollectionQuery

Enclosing class:

Storefront

public static class Storefront.CollectionQuery
extends Query<Storefront.CollectionQuery>

A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.CollectionQuery.DescriptionArguments
static interface	Storefront.CollectionQuery.DescriptionArgumentsDefinition
class	Storefront.CollectionQuery.MetafieldArguments
static interface	Storefront.CollectionQuery.MetafieldArgumentsDefinition
class	Storefront.CollectionQuery.ProductsArguments
static interface	Storefront.CollectionQuery.ProductsArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.CollectionQuery	description() Stripped description of the collection, single line with HTML tags removed.
Storefront.CollectionQuery	description(Storefront.CollectionQuery.DescriptionArgumentsDefinition argsDef) Stripped description of the collection, single line with HTML tags removed.
Storefront.CollectionQuery	descriptionHtml() The description of the collection, complete with HTML formatting.
Storefront.CollectionQuery	handle() A human-friendly unique string for the collection automatically generated from its title.
Storefront.CollectionQuery	image(Storefront.ImageQueryDefinition queryDef) Image associated with the collection.
Storefront.CollectionQuery	metafield(java.lang.String key, Storefront.CollectionQuery.MetafieldArgumentsDefinition argsDef, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.CollectionQuery	metafield(java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.CollectionQuery	metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers, Storefront.MetafieldQueryDefinition queryDef) The metafields associated with the resource matching the supplied list of namespaces and keys.
Storefront.CollectionQuery	onlineStoreUrl() The URL used for viewing the resource on the shop's Online Store.
Storefront.CollectionQuery	products(Storefront.CollectionQuery.ProductsArgumentsDefinition argsDef, Storefront.ProductConnectionQueryDefinition queryDef) List of products in the collection.
Storefront.CollectionQuery	products(Storefront.ProductConnectionQueryDefinition queryDef) List of products in the collection.
Storefront.CollectionQuery	seo(Storefront.SEOQueryDefinition queryDef) The collection's SEO information.
Storefront.CollectionQuery	title() The collection’s name.
Storefront.CollectionQuery	trackingParameters() A URL parameters to be added to a page URL when it is linked from a GraphQL result.
Storefront.CollectionQuery	updatedAt() The date and time when the collection was last modified.

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

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

description

public Storefront.CollectionQuery description()

Stripped description of the collection, single line with HTML tags removed.

description

public Storefront.CollectionQuery description(Storefront.CollectionQuery.DescriptionArgumentsDefinition argsDef)

Stripped description of the collection, single line with HTML tags removed.

descriptionHtml

public Storefront.CollectionQuery descriptionHtml()

The description of the collection, complete with HTML formatting.

handle

public Storefront.CollectionQuery handle()

A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

image

public Storefront.CollectionQuery image(Storefront.ImageQueryDefinition queryDef)

Image associated with the collection.

metafield

public Storefront.CollectionQuery metafield(java.lang.String key,
                                            Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafield

public Storefront.CollectionQuery metafield(java.lang.String key,
                                            Storefront.CollectionQuery.MetafieldArgumentsDefinition argsDef,
                                            Storefront.MetafieldQueryDefinition queryDef)

Returns a metafield found by namespace and key.

metafields

public Storefront.CollectionQuery metafields(java.util.List<Storefront.HasMetafieldsIdentifier> identifiers,
                                             Storefront.MetafieldQueryDefinition queryDef)

The metafields associated with the resource matching the supplied list of namespaces and keys.

onlineStoreUrl

public Storefront.CollectionQuery onlineStoreUrl()

The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.

products

public Storefront.CollectionQuery products(Storefront.ProductConnectionQueryDefinition queryDef)

List of products in the collection.

products

public Storefront.CollectionQuery products(Storefront.CollectionQuery.ProductsArgumentsDefinition argsDef,
                                           Storefront.ProductConnectionQueryDefinition queryDef)

List of products in the collection.

seo

public Storefront.CollectionQuery seo(Storefront.SEOQueryDefinition queryDef)

The collection's SEO information.

title

public Storefront.CollectionQuery title()

The collection’s name. Limit of 255 characters.

trackingParameters

public Storefront.CollectionQuery trackingParameters()

A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.

updatedAt

public Storefront.CollectionQuery updatedAt()

The date and time when the collection was last modified.