com.shopify.buy3

Class Storefront.CollectionQuery

java.lang.Object

<any>

com.shopify.buy3.Storefront.CollectionQuery

Enclosing class:

Storefront

public static class Storefront.CollectionQuery
extends <any>

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.ImageArguments
static interface	Storefront.CollectionQuery.ImageArgumentsDefinition
class	Storefront.CollectionQuery.ProductsArguments
static interface	Storefront.CollectionQuery.ProductsArgumentsDefinition

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.CollectionQuery.ImageArgumentsDefinition argsDef, Storefront.ImageQueryDefinition queryDef) Image associated with the collection.
Storefront.CollectionQuery	image(Storefront.ImageQueryDefinition queryDef) Image associated with the collection.
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	title() The collection’s name.
Storefront.CollectionQuery	updatedAt() The date and time when the collection was last modified.

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.

image

public Storefront.CollectionQuery image(Storefront.CollectionQuery.ImageArgumentsDefinition argsDef,
                                        Storefront.ImageQueryDefinition queryDef)

Image associated with the collection.

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.

title

public Storefront.CollectionQuery title()

The collection’s name. Limit of 255 characters.

updatedAt

public Storefront.CollectionQuery updatedAt()

The date and time when the collection was last modified.