Shopify.Unity.GraphQL.CollectionQuery Class Reference

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

Public Member Functions
	CollectionQuery (StringBuilder query)
	CollectionQuery is used to build queries. Typically CollectionQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...
CollectionQuery	description (long? truncateAt=null, string alias=null)
	Stripped description of the collection, single line with HTML tags removed. More...
CollectionQuery	descriptionHtml ()
	The description of the collection, complete with HTML formatting. More...
CollectionQuery	handle ()
	A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters. More...
CollectionQuery	id ()
	Globally unique identifier. More...
CollectionQuery	image (ImageDelegate buildQuery, long? maxWidth=null, long? maxHeight=null, CropRegion? crop=null, long? scale=null, string alias=null)
	Image associated with the collection. More...
CollectionQuery	products (ProductConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, ProductCollectionSortKeys? sortKey=null, string alias=null)
	List of products in the collection. More...
CollectionQuery	title ()
	The collection’s name. Limit of 255 characters. More...
CollectionQuery	updatedAt ()
	The date and time when the collection was last modified. More...

Detailed Description

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

Constructor & Destructor Documentation

CollectionQuery()

Shopify.Unity.GraphQL.CollectionQuery.CollectionQuery ( StringBuilder  query )

inline

CollectionQuery is used to build queries. Typically CollectionQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery.

Member Function Documentation

description()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.description ( long?  truncateAt = null, string  alias = null  )

inline

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

Parameters

truncateAt

Truncates string after the given length.

descriptionHtml()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.descriptionHtml ( )

inline

The description of the collection, complete with HTML formatting.

handle()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.handle ( )

inline

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

id()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.id ( )

inline

Globally unique identifier.

image()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.image ( ImageDelegate  buildQuery, long?  maxWidth = null, long?  maxHeight = null, CropRegion?  crop = null, long?  scale = null, string  alias = null  )

inline

Image associated with the collection.

Parameters

maxWidth	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
maxHeight	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
crop	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
scale	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.

products()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.products ( ProductConnectionDelegate  buildQuery, long?  first = null, string  after = null, long?  last = null, string  before = null, bool?  reverse = null, ProductCollectionSortKeys?  sortKey = null, string  alias = null  )

inline

List of products in the collection.

Parameters

first	Returns up to the first n elements from the list.
after	Returns the elements that come after the specified cursor.
last	Returns up to the last n elements from the list.
before	Returns the elements that come before the specified cursor.
reverse	Reverse the order of the underlying list.
sortKey	Sort the underlying list by the given key.

title()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.title ( )

inline

The collection’s name. Limit of 255 characters.

updatedAt()

CollectionQuery Shopify.Unity.GraphQL.CollectionQuery.updatedAt ( )

inline

The date and time when the collection was last modified.

---

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

• Assets/Shopify/Unity/Generated/GraphQL/CollectionQuery.cs