com.adobe.cq.commerce.magento.graphql

Class ProductImageQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<ProductImageQuery>

com.adobe.cq.commerce.magento.graphql.ProductImageQuery

public class ProductImageQuery
extends AbstractQuery<ProductImageQuery>

Product image information. Contains the image URL and label.

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
ProductImageQuery	addFragmentReference(Fragment<ProductImageQuery> fragment) Adds a ProductImageQuery fragment reference at the current position of the query.
ProductImageQuery	addMediaGalleryInterfaceFragmentReference(Fragment<MediaGalleryInterfaceQuery> fragment) Adds a MediaGalleryInterfaceQuery fragment reference at the current position of the query.
static Fragment<ProductImageQuery>	createFragment(String name, ProductImageQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
ProductImageQuery	disabled() Whether the image is hidden from view.
ProductImageQuery	label() The label of the product image or video.
ProductImageQuery	position() The media item's position after it has been sorted.
ProductImageQuery	url() The URL of the product image or video.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

disabled

public ProductImageQuery disabled()

Whether the image is hidden from view.

label

public ProductImageQuery label()

The label of the product image or video.

position

public ProductImageQuery position()

The media item's position after it has been sorted.

url

public ProductImageQuery url()

The URL of the product image or video.

createFragment

public static Fragment<ProductImageQuery> createFragment(String name,
                                                         ProductImageQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public ProductImageQuery addFragmentReference(Fragment<ProductImageQuery> fragment)

Adds a ProductImageQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.

addMediaGalleryInterfaceFragmentReference

public ProductImageQuery addMediaGalleryInterfaceFragmentReference(Fragment<MediaGalleryInterfaceQuery> fragment)

Adds a MediaGalleryInterfaceQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query.

Parameters:

fragment - The fragment to reference.