com.shopify.buy3

Class Storefront.MetafieldQuery

java.lang.Object

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

com.shopify.buy3.Storefront.MetafieldQuery

Enclosing class:

Storefront

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

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.MetafieldQuery.ReferencesArguments
static interface	Storefront.MetafieldQuery.ReferencesArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.MetafieldQuery	createdAt() The date and time when the storefront metafield was created.
Storefront.MetafieldQuery	description() The description of a metafield.
Storefront.MetafieldQuery	key() The unique identifier for the metafield within its namespace.
Storefront.MetafieldQuery	namespace() The container for a group of metafields that the metafield is associated with.
Storefront.MetafieldQuery	parentResource(Storefront.MetafieldParentResourceQueryDefinition queryDef) The type of resource that the metafield is attached to.
Storefront.MetafieldQuery	reference(Storefront.MetafieldReferenceQueryDefinition queryDef) Returns a reference object if the metafield's type is a resource reference.
Storefront.MetafieldQuery	references(Storefront.MetafieldQuery.ReferencesArgumentsDefinition argsDef, Storefront.MetafieldReferenceConnectionQueryDefinition queryDef) A list of reference objects if the metafield's type is a resource reference list.
Storefront.MetafieldQuery	references(Storefront.MetafieldReferenceConnectionQueryDefinition queryDef) A list of reference objects if the metafield's type is a resource reference list.
Storefront.MetafieldQuery	type() The type name of the metafield.
Storefront.MetafieldQuery	updatedAt() The date and time when the metafield was last updated.
Storefront.MetafieldQuery	value() The data stored in the metafield.

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

createdAt

public Storefront.MetafieldQuery createdAt()

The date and time when the storefront metafield was created.

description

public Storefront.MetafieldQuery description()

The description of a metafield.

key

public Storefront.MetafieldQuery key()

The unique identifier for the metafield within its namespace.

namespace

public Storefront.MetafieldQuery namespace()

The container for a group of metafields that the metafield is associated with.

parentResource

public Storefront.MetafieldQuery parentResource(Storefront.MetafieldParentResourceQueryDefinition queryDef)

The type of resource that the metafield is attached to.

reference

public Storefront.MetafieldQuery reference(Storefront.MetafieldReferenceQueryDefinition queryDef)

Returns a reference object if the metafield's type is a resource reference.

references

public Storefront.MetafieldQuery references(Storefront.MetafieldReferenceConnectionQueryDefinition queryDef)

A list of reference objects if the metafield's type is a resource reference list.

references

public Storefront.MetafieldQuery references(Storefront.MetafieldQuery.ReferencesArgumentsDefinition argsDef,
                                            Storefront.MetafieldReferenceConnectionQueryDefinition queryDef)

A list of reference objects if the metafield's type is a resource reference list.

type

public Storefront.MetafieldQuery type()

The type name of the metafield. Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).

updatedAt

public Storefront.MetafieldQuery updatedAt()

The date and time when the metafield was last updated.

value

public Storefront.MetafieldQuery value()

The data stored in the metafield. Always stored as a string, regardless of the metafield's type.