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

An article in an online store blog. More...

Public Member Functions

 ArticleQuery (StringBuilder query)
 ArticleQuery is used to build queries. Typically ArticleQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...
 
ArticleQuery author (ArticleAuthorDelegate buildQuery)
 The article's author. More...
 
ArticleQuery authorV2 (ArticleAuthorDelegate buildQuery)
 The article's author. More...
 
ArticleQuery blog (BlogDelegate buildQuery)
 The blog that the article belongs to. More...
 
ArticleQuery comments (CommentConnectionDelegate buildQuery, long? first=null, string after=null, long? last=null, string before=null, bool? reverse=null, string alias=null)
 List of comments posted on the article. More...
 
ArticleQuery content (long? truncateAt=null, string alias=null)
 Stripped content of the article, single line with HTML tags removed. More...
 
ArticleQuery contentHtml ()
 The content of the article, complete with HTML formatting. More...
 
ArticleQuery excerpt (long? truncateAt=null, string alias=null)
 Stripped excerpt of the article, single line with HTML tags removed. More...
 
ArticleQuery excerptHtml ()
 The excerpt of the article, complete with HTML formatting. More...
 
ArticleQuery handle ()
 A human-friendly unique string for the Article automatically generated from its title. More...
 
ArticleQuery id ()
 Globally unique identifier. More...
 
ArticleQuery image (ImageDelegate buildQuery, long? maxWidth=null, long? maxHeight=null, CropRegion? crop=null, long? scale=null, string alias=null)
 The image associated with the article. More...
 
ArticleQuery publishedAt ()
 The date and time when the article was published. More...
 
ArticleQuery seo (SeoDelegate buildQuery)
 The article’s SEO information. More...
 
ArticleQuery tags ()
 A categorization that a article can be tagged with. More...
 
ArticleQuery title ()
 The article’s name. More...
 
ArticleQuery url ()
 The url pointing to the article accessible from the web. More...
 

Detailed Description

An article in an online store blog.

Constructor & Destructor Documentation

◆ ArticleQuery()

Shopify.Unity.GraphQL.ArticleQuery.ArticleQuery ( StringBuilder  query)
inline

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

Member Function Documentation

◆ author()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.author ( ArticleAuthorDelegate  buildQuery)
inline

The article's author.

Deprecated:
Use authorV2 instead

◆ authorV2()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.authorV2 ( ArticleAuthorDelegate  buildQuery)
inline

The article's author.

◆ blog()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.blog ( BlogDelegate  buildQuery)
inline

The blog that the article belongs to.

◆ comments()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.comments ( CommentConnectionDelegate  buildQuery,
long?  first = null,
string  after = null,
long?  last = null,
string  before = null,
bool?  reverse = null,
string  alias = null 
)
inline

List of comments posted on the article.

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.

◆ content()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.content ( long?  truncateAt = null,
string  alias = null 
)
inline

Stripped content of the article, single line with HTML tags removed.

Parameters
truncateAtTruncates string after the given length.

◆ contentHtml()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.contentHtml ( )
inline

The content of the article, complete with HTML formatting.

◆ excerpt()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.excerpt ( long?  truncateAt = null,
string  alias = null 
)
inline

Stripped excerpt of the article, single line with HTML tags removed.

Parameters
truncateAtTruncates string after the given length.

◆ excerptHtml()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.excerptHtml ( )
inline

The excerpt of the article, complete with HTML formatting.

◆ handle()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.handle ( )
inline

A human-friendly unique string for the Article automatically generated from its title.

◆ id()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.id ( )
inline

Globally unique identifier.

◆ image()

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

The image associated with the article.

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

◆ publishedAt()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.publishedAt ( )
inline

The date and time when the article was published.

◆ seo()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.seo ( SeoDelegate  buildQuery)
inline

The article’s SEO information.

◆ tags()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.tags ( )
inline

A categorization that a article can be tagged with.

◆ title()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.title ( )
inline

The article’s name.

◆ url()

ArticleQuery Shopify.Unity.GraphQL.ArticleQuery.url ( )
inline

The url pointing to the article accessible from the web.


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