com.shopify.buy3

Class Storefront.Page

java.lang.Object

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

com.shopify.buy3.Storefront.Page

All Implemented Interfaces:

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

Enclosing class:

Storefront

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

Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store.

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
Page()
Page(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody() The description of the page, complete with HTML formatting.
java.lang.String	getBodySummary() Summary of the page body.
DateTime	getCreatedAt() The timestamp of the page creation.
java.lang.String	getGraphQlTypeName()
java.lang.String	getHandle() A human-friendly unique string for the page automatically generated from its title.
ID	getId() A globally-unique ID.
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.SEO	getSeo() The page's SEO information.
java.lang.String	getTitle() The title of the page.
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 timestamp of the latest page update.
Storefront.Page	setBody(java.lang.String arg)
Storefront.Page	setBodySummary(java.lang.String arg)
Storefront.Page	setCreatedAt(DateTime arg)
Storefront.Page	setHandle(java.lang.String arg)
Storefront.Page	setMetafield(Storefront.Metafield arg)
Storefront.Page	setMetafields(java.util.List<Storefront.Metafield> arg)
Storefront.Page	setOnlineStoreUrl(java.lang.String arg)
Storefront.Page	setSeo(Storefront.SEO arg)
Storefront.Page	setTitle(java.lang.String arg)
Storefront.Page	setTrackingParameters(java.lang.String arg)
Storefront.Page	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

Page

public Page()

Page

public Page(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.SearchResultItem

Specified by:

getGraphQlTypeName in interface Storefront.Trackable

Specified by:

getGraphQlTypeName in interface Node

getBody

public java.lang.String getBody()

The description of the page, complete with HTML formatting.

setBody

public Storefront.Page setBody(java.lang.String arg)

getBodySummary

public java.lang.String getBodySummary()

Summary of the page body.

setBodySummary

public Storefront.Page setBodySummary(java.lang.String arg)

getCreatedAt

public DateTime getCreatedAt()

The timestamp of the page creation.

setCreatedAt

public Storefront.Page setCreatedAt(DateTime arg)

getHandle

public java.lang.String getHandle()

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

setHandle

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

getMetafield

public Storefront.Metafield getMetafield()

Returns a metafield found by namespace and key.

Specified by:

getMetafield in interface Storefront.HasMetafields

setMetafield

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

getSeo

public Storefront.SEO getSeo()

The page's SEO information.

setSeo

public Storefront.Page setSeo(Storefront.SEO arg)

getTitle

public java.lang.String getTitle()

The title of the page.

setTitle

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

getUpdatedAt

public DateTime getUpdatedAt()

The timestamp of the latest page update.

setUpdatedAt

public Storefront.Page setUpdatedAt(DateTime arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Page>