com.shopify.buy3

Class Storefront.Collection

java.lang.Object

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

com.shopify.buy3.Storefront.Collection

All Implemented Interfaces:

Storefront.HasMetafields, Storefront.MenuItemResource, Storefront.MetafieldParentResource, Storefront.MetafieldReference, Storefront.Node, Storefront.OnlineStorePublishable, Storefront.Trackable, Node, java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.Collection
extends AbstractResponse<Storefront.Collection>
implements Storefront.HasMetafields, Storefront.MenuItemResource, Storefront.MetafieldParentResource, Storefront.MetafieldReference, Storefront.Node, Storefront.OnlineStorePublishable, Storefront.Trackable

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

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
Collection()
Collection(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Stripped description of the collection, single line with HTML tags removed.
java.lang.String	getDescriptionHtml() The description of the collection, complete with HTML formatting.
java.lang.String	getGraphQlTypeName()
java.lang.String	getHandle() A human-friendly unique string for the collection automatically generated from its title.
ID	getId() A globally-unique ID.
Storefront.Image	getImage() Image associated with the collection.
Storefront.Metafield	getMetafield() Returns a metafield found by namespace and key.
java.util.List<Storefront.Metafield>	getMetafields() The metafields associated with the resource matching the supplied list of namespaces and keys.
java.lang.String	getOnlineStoreUrl() The URL used for viewing the resource on the shop's Online Store.
Storefront.ProductConnection	getProducts() List of products in the collection.
Storefront.SEO	getSeo() The collection's SEO information.
java.lang.String	getTitle() The collection’s name.
java.lang.String	getTrackingParameters() A URL parameters to be added to a page URL when it is linked from a GraphQL result.
DateTime	getUpdatedAt() The date and time when the collection was last modified.
Storefront.Collection	setDescription(java.lang.String arg)
Storefront.Collection	setDescriptionHtml(java.lang.String arg)
Storefront.Collection	setHandle(java.lang.String arg)
Storefront.Collection	setImage(Storefront.Image arg)
Storefront.Collection	setMetafield(Storefront.Metafield arg)
Storefront.Collection	setMetafields(java.util.List<Storefront.Metafield> arg)
Storefront.Collection	setOnlineStoreUrl(java.lang.String arg)
Storefront.Collection	setProducts(Storefront.ProductConnection arg)
Storefront.Collection	setSeo(Storefront.SEO arg)
Storefront.Collection	setTitle(java.lang.String arg)
Storefront.Collection	setTrackingParameters(java.lang.String arg)
Storefront.Collection	setUpdatedAt(DateTime 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

Collection

public Collection()

Collection

public Collection(JsonObject fields)
           throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.HasMetafields

Specified by:

getGraphQlTypeName in interface Storefront.MenuItemResource

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldParentResource

Specified by:

getGraphQlTypeName in interface Storefront.MetafieldReference

Specified by:

getGraphQlTypeName in interface Storefront.Node

Specified by:

getGraphQlTypeName in interface Storefront.OnlineStorePublishable

Specified by:

getGraphQlTypeName in interface Storefront.Trackable

Specified by:

getGraphQlTypeName in interface Node

getDescription

public java.lang.String getDescription()

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

setDescription

public Storefront.Collection setDescription(java.lang.String arg)

getDescriptionHtml

public java.lang.String getDescriptionHtml()

The description of the collection, complete with HTML formatting.

setDescriptionHtml

public Storefront.Collection setDescriptionHtml(java.lang.String arg)

getHandle

public java.lang.String getHandle()

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

setHandle

public Storefront.Collection setHandle(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

getImage

public Storefront.Image getImage()

Image associated with the collection.

setImage

public Storefront.Collection setImage(Storefront.Image arg)

getMetafield

public Storefront.Metafield getMetafield()

Returns a metafield found by namespace and key.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

public Storefront.Collection setMetafield(Storefront.Metafield arg)

getMetafields

public java.util.List<Storefront.Metafield> getMetafields()

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

Specified by:

getMetafields in interface Storefront.HasMetafields

setMetafields

public Storefront.Collection setMetafields(java.util.List<Storefront.Metafield> arg)

getOnlineStoreUrl

public java.lang.String getOnlineStoreUrl()

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.

Specified by:

getOnlineStoreUrl in interface Storefront.OnlineStorePublishable

setOnlineStoreUrl

public Storefront.Collection setOnlineStoreUrl(java.lang.String arg)

getProducts

public Storefront.ProductConnection getProducts()

List of products in the collection.

setProducts

public Storefront.Collection setProducts(Storefront.ProductConnection arg)

getSeo

public Storefront.SEO getSeo()

The collection's SEO information.

setSeo

public Storefront.Collection setSeo(Storefront.SEO arg)

getTitle

public java.lang.String getTitle()

The collection’s name. Limit of 255 characters.

setTitle

public Storefront.Collection setTitle(java.lang.String arg)

getTrackingParameters

public java.lang.String getTrackingParameters()

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.

Specified by:

getTrackingParameters in interface Storefront.Trackable

setTrackingParameters

public Storefront.Collection setTrackingParameters(java.lang.String arg)

getUpdatedAt

public DateTime getUpdatedAt()

The date and time when the collection was last modified.

setUpdatedAt

public Storefront.Collection setUpdatedAt(DateTime arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Collection>