com.adobe.cq.commerce.magento.graphql

Class MediaGalleryEntryQuery

java.lang.Object

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

com.adobe.cq.commerce.magento.graphql.MediaGalleryEntryQuery

public class MediaGalleryEntryQuery
extends AbstractQuery<MediaGalleryEntryQuery>

MediaGalleryEntry defines characteristics about images and videos associated with a specific product.

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
MediaGalleryEntryQuery	addFragmentReference(Fragment<MediaGalleryEntryQuery> fragment) Adds a MediaGalleryEntryQuery fragment reference at the current position of the query.
MediaGalleryEntryQuery	content(ProductMediaGalleryEntriesContentQueryDefinition queryDef) Contains a ProductMediaGalleryEntriesContent object.
static Fragment<MediaGalleryEntryQuery>	createFragment(String name, MediaGalleryEntryQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
MediaGalleryEntryQuery	disabled() Whether the image is hidden from view.
MediaGalleryEntryQuery	file() The path of the image on the server.
MediaGalleryEntryQuery	id() Deprecated. Use `uid` instead.
MediaGalleryEntryQuery	label() The alt text displayed on the UI when the user points to the image.
MediaGalleryEntryQuery	mediaType() image or video.
MediaGalleryEntryQuery	position() The media item's position after it has been sorted.
MediaGalleryEntryQuery	types() Array of image types.
MediaGalleryEntryQuery	uid() The unique ID for a `MediaGalleryEntry` object.
MediaGalleryEntryQuery	videoContent(ProductMediaGalleryEntriesVideoContentQueryDefinition queryDef) Contains a ProductMediaGalleryEntriesVideoContent object.

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

content

public MediaGalleryEntryQuery content(ProductMediaGalleryEntriesContentQueryDefinition queryDef)

Contains a ProductMediaGalleryEntriesContent object.

disabled

public MediaGalleryEntryQuery disabled()

Whether the image is hidden from view.

file

public MediaGalleryEntryQuery file()

The path of the image on the server.

id

@Deprecated
public MediaGalleryEntryQuery id()

Deprecated. Use `uid` instead.

The identifier assigned to the object.

label

public MediaGalleryEntryQuery label()

The alt text displayed on the UI when the user points to the image.

mediaType

public MediaGalleryEntryQuery mediaType()

image or video.

position

public MediaGalleryEntryQuery position()

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

types

public MediaGalleryEntryQuery types()

Array of image types. It can have the following values: image, small_image, thumbnail.

uid

public MediaGalleryEntryQuery uid()

The unique ID for a `MediaGalleryEntry` object.

videoContent

public MediaGalleryEntryQuery videoContent(ProductMediaGalleryEntriesVideoContentQueryDefinition queryDef)

Contains a ProductMediaGalleryEntriesVideoContent object.

createFragment

public static Fragment<MediaGalleryEntryQuery> createFragment(String name,
                                                              MediaGalleryEntryQueryDefinition 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 MediaGalleryEntryQuery addFragmentReference(Fragment<MediaGalleryEntryQuery> fragment)

Adds a MediaGalleryEntryQuery 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.