com.shopify.buy3

Class Storefront.ArticleQuery

java.lang.Object

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

com.shopify.buy3.Storefront.ArticleQuery

Enclosing class:

Storefront

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

An article in an online store blog.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.ArticleQuery.CommentsArguments
static interface	Storefront.ArticleQuery.CommentsArgumentsDefinition
class	Storefront.ArticleQuery.ContentArguments
static interface	Storefront.ArticleQuery.ContentArgumentsDefinition
class	Storefront.ArticleQuery.ExcerptArguments
static interface	Storefront.ArticleQuery.ExcerptArgumentsDefinition
class	Storefront.ArticleQuery.MetafieldArguments
static interface	Storefront.ArticleQuery.MetafieldArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.ArticleQuery	author(Storefront.ArticleAuthorQueryDefinition queryDef) Deprecated. Use `authorV2` instead.
Storefront.ArticleQuery	authorV2(Storefront.ArticleAuthorQueryDefinition queryDef) The article's author.
Storefront.ArticleQuery	blog(Storefront.BlogQueryDefinition queryDef) The blog that the article belongs to.
Storefront.ArticleQuery	comments(Storefront.ArticleQuery.CommentsArgumentsDefinition argsDef, Storefront.CommentConnectionQueryDefinition queryDef) List of comments posted on the article.
Storefront.ArticleQuery	comments(Storefront.CommentConnectionQueryDefinition queryDef) List of comments posted on the article.
Storefront.ArticleQuery	content() Stripped content of the article, single line with HTML tags removed.
Storefront.ArticleQuery	content(Storefront.ArticleQuery.ContentArgumentsDefinition argsDef) Stripped content of the article, single line with HTML tags removed.
Storefront.ArticleQuery	contentHtml() The content of the article, complete with HTML formatting.
Storefront.ArticleQuery	excerpt() Stripped excerpt of the article, single line with HTML tags removed.
Storefront.ArticleQuery	excerpt(Storefront.ArticleQuery.ExcerptArgumentsDefinition argsDef) Stripped excerpt of the article, single line with HTML tags removed.
Storefront.ArticleQuery	excerptHtml() The excerpt of the article, complete with HTML formatting.
Storefront.ArticleQuery	handle() A human-friendly unique string for the Article automatically generated from its title.
Storefront.ArticleQuery	image(Storefront.ImageQueryDefinition queryDef) The image associated with the article.
Storefront.ArticleQuery	metafield(java.lang.String key, Storefront.ArticleQuery.MetafieldArgumentsDefinition argsDef, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.ArticleQuery	metafield(java.lang.String key, Storefront.MetafieldQueryDefinition queryDef) Returns a metafield found by namespace and key.
Storefront.ArticleQuery	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.ArticleQuery	onlineStoreUrl() The URL used for viewing the resource on the shop's Online Store.
Storefront.ArticleQuery	publishedAt() The date and time when the article was published.
Storefront.ArticleQuery	seo(Storefront.SEOQueryDefinition queryDef) The article’s SEO information.
Storefront.ArticleQuery	tags() A categorization that a article can be tagged with.
Storefront.ArticleQuery	title() The article’s name.
Storefront.ArticleQuery	trackingParameters() A URL parameters to be added to a page URL when it is linked from a GraphQL result.

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

author

@Deprecated
public Storefront.ArticleQuery author(Storefront.ArticleAuthorQueryDefinition queryDef)

Deprecated. Use `authorV2` instead.

The article's author.

authorV2

public Storefront.ArticleQuery authorV2(Storefront.ArticleAuthorQueryDefinition queryDef)

The article's author.

blog

public Storefront.ArticleQuery blog(Storefront.BlogQueryDefinition queryDef)

The blog that the article belongs to.

comments

public Storefront.ArticleQuery comments(Storefront.CommentConnectionQueryDefinition queryDef)

List of comments posted on the article.

comments

public Storefront.ArticleQuery comments(Storefront.ArticleQuery.CommentsArgumentsDefinition argsDef,
                                        Storefront.CommentConnectionQueryDefinition queryDef)

List of comments posted on the article.

content

public Storefront.ArticleQuery content()

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

content

public Storefront.ArticleQuery content(Storefront.ArticleQuery.ContentArgumentsDefinition argsDef)

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

contentHtml

public Storefront.ArticleQuery contentHtml()

The content of the article, complete with HTML formatting.

excerpt

public Storefront.ArticleQuery excerpt()

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

excerpt

public Storefront.ArticleQuery excerpt(Storefront.ArticleQuery.ExcerptArgumentsDefinition argsDef)

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

excerptHtml

public Storefront.ArticleQuery excerptHtml()

The excerpt of the article, complete with HTML formatting.

handle

public Storefront.ArticleQuery handle()

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

image

public Storefront.ArticleQuery image(Storefront.ImageQueryDefinition queryDef)

The image associated with the article.

metafield

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

Returns a metafield found by namespace and key.

metafield

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

Returns a metafield found by namespace and key.

metafields

public Storefront.ArticleQuery 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.ArticleQuery 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.

publishedAt

public Storefront.ArticleQuery publishedAt()

The date and time when the article was published.

seo

public Storefront.ArticleQuery seo(Storefront.SEOQueryDefinition queryDef)

The article’s SEO information.

tags

public Storefront.ArticleQuery tags()

A categorization that a article can be tagged with.

title

public Storefront.ArticleQuery title()

The article’s name.

trackingParameters

public Storefront.ArticleQuery 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.