com.shopify.buy3

Class Storefront.Article

java.lang.Object

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

com.shopify.buy3.Storefront.Article

All Implemented Interfaces:

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

Enclosing class:

Storefront

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

An article in an online store blog.

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
Article()
Article(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
Storefront.ArticleAuthor	getAuthor() Deprecated. Use `authorV2` instead.
Storefront.ArticleAuthor	getAuthorV2() The article's author.
Storefront.Blog	getBlog() The blog that the article belongs to.
Storefront.CommentConnection	getComments() List of comments posted on the article.
java.lang.String	getContent() Stripped content of the article, single line with HTML tags removed.
java.lang.String	getContentHtml() The content of the article, complete with HTML formatting.
java.lang.String	getExcerpt() Stripped excerpt of the article, single line with HTML tags removed.
java.lang.String	getExcerptHtml() The excerpt of the article, complete with HTML formatting.
java.lang.String	getGraphQlTypeName()
java.lang.String	getHandle() A human-friendly unique string for the Article automatically generated from its title.
ID	getId() A globally-unique ID.
Storefront.Image	getImage() The image associated with the article.
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.
DateTime	getPublishedAt() The date and time when the article was published.
Storefront.SEO	getSeo() The article’s SEO information.
java.util.List<java.lang.String>	getTags() A categorization that a article can be tagged with.
java.lang.String	getTitle() The article’s name.
java.lang.String	getTrackingParameters() A URL parameters to be added to a page URL when it is linked from a GraphQL result.
Storefront.Article	setAuthor(Storefront.ArticleAuthor arg)
Storefront.Article	setAuthorV2(Storefront.ArticleAuthor arg)
Storefront.Article	setBlog(Storefront.Blog arg)
Storefront.Article	setComments(Storefront.CommentConnection arg)
Storefront.Article	setContent(java.lang.String arg)
Storefront.Article	setContentHtml(java.lang.String arg)
Storefront.Article	setExcerpt(java.lang.String arg)
Storefront.Article	setExcerptHtml(java.lang.String arg)
Storefront.Article	setHandle(java.lang.String arg)
Storefront.Article	setImage(Storefront.Image arg)
Storefront.Article	setMetafield(Storefront.Metafield arg)
Storefront.Article	setMetafields(java.util.List<Storefront.Metafield> arg)
Storefront.Article	setOnlineStoreUrl(java.lang.String arg)
Storefront.Article	setPublishedAt(DateTime arg)
Storefront.Article	setSeo(Storefront.SEO arg)
Storefront.Article	setTags(java.util.List<java.lang.String> arg)
Storefront.Article	setTitle(java.lang.String arg)
Storefront.Article	setTrackingParameters(java.lang.String 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

Article

public Article()

Article

public Article(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.Node

Specified by:

getGraphQlTypeName in interface Storefront.OnlineStorePublishable

Specified by:

getGraphQlTypeName in interface Storefront.SearchResultItem

Specified by:

getGraphQlTypeName in interface Storefront.Trackable

Specified by:

getGraphQlTypeName in interface Node

getAuthor

public Storefront.ArticleAuthor getAuthor()

Deprecated. Use `authorV2` instead.

The article's author.

setAuthor

public Storefront.Article setAuthor(Storefront.ArticleAuthor arg)

getAuthorV2

public Storefront.ArticleAuthor getAuthorV2()

The article's author.

setAuthorV2

public Storefront.Article setAuthorV2(Storefront.ArticleAuthor arg)

getBlog

public Storefront.Blog getBlog()

The blog that the article belongs to.

setBlog

public Storefront.Article setBlog(Storefront.Blog arg)

getComments

public Storefront.CommentConnection getComments()

List of comments posted on the article.

setComments

public Storefront.Article setComments(Storefront.CommentConnection arg)

getContent

public java.lang.String getContent()

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

setContent

public Storefront.Article setContent(java.lang.String arg)

getContentHtml

public java.lang.String getContentHtml()

The content of the article, complete with HTML formatting.

setContentHtml

public Storefront.Article setContentHtml(java.lang.String arg)

getExcerpt

public java.lang.String getExcerpt()

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

setExcerpt

public Storefront.Article setExcerpt(java.lang.String arg)

getExcerptHtml

public java.lang.String getExcerptHtml()

The excerpt of the article, complete with HTML formatting.

setExcerptHtml

public Storefront.Article setExcerptHtml(java.lang.String arg)

getHandle

public java.lang.String getHandle()

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

setHandle

public Storefront.Article 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()

The image associated with the article.

setImage

public Storefront.Article 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.Article 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.Article 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.Article setOnlineStoreUrl(java.lang.String arg)

getPublishedAt

public DateTime getPublishedAt()

The date and time when the article was published.

setPublishedAt

public Storefront.Article setPublishedAt(DateTime arg)

getSeo

public Storefront.SEO getSeo()

The article’s SEO information.

setSeo

public Storefront.Article setSeo(Storefront.SEO arg)

getTags

public java.util.List<java.lang.String> getTags()

A categorization that a article can be tagged with.

setTags

public Storefront.Article setTags(java.util.List<java.lang.String> arg)

getTitle

public java.lang.String getTitle()

The article’s name.

setTitle

public Storefront.Article 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.Article setTrackingParameters(java.lang.String arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Article>