com.shopify.buy3

Class Storefront.ImageQuery

java.lang.Object

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

com.shopify.buy3.Storefront.ImageQuery

Enclosing class:

Storefront

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

Represents an image resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.ImageQuery.TransformedSrcArguments
static interface	Storefront.ImageQuery.TransformedSrcArgumentsDefinition
class	Storefront.ImageQuery.UrlArguments
static interface	Storefront.ImageQuery.UrlArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.ImageQuery	altText() A word or phrase to share the nature or contents of an image.
Storefront.ImageQuery	height() The original height of the image in pixels.
Storefront.ImageQuery	id() A unique ID for the image.
Storefront.ImageQuery	originalSrc() Deprecated. Use `url` instead.
Storefront.ImageQuery	src() Deprecated. Use `url` instead.
Storefront.ImageQuery	transformedSrc() Deprecated. Use `url(transform:)` instead
Storefront.ImageQuery	transformedSrc(Storefront.ImageQuery.TransformedSrcArgumentsDefinition argsDef) Deprecated. Use `url(transform:)` instead
Storefront.ImageQuery	url() The location of the image as a URL.
Storefront.ImageQuery	url(Storefront.ImageQuery.UrlArgumentsDefinition argsDef) The location of the image as a URL.
Storefront.ImageQuery	width() The original width of the image in pixels.

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

altText

public Storefront.ImageQuery altText()

A word or phrase to share the nature or contents of an image.

height

public Storefront.ImageQuery height()

The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify.

id

public Storefront.ImageQuery id()

A unique ID for the image.

originalSrc

@Deprecated
public Storefront.ImageQuery originalSrc()

Deprecated. Use `url` instead.

The location of the original image as a URL. If there are any existing transformations in the original source URL, they will remain and not be stripped.

src

@Deprecated
public Storefront.ImageQuery src()

Deprecated. Use `url` instead.

The location of the image as a URL.

transformedSrc

public Storefront.ImageQuery transformedSrc()

Deprecated. Use `url(transform:)` instead

The location of the transformed image as a URL. All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. Otherwise any transformations which an image type doesn't support will be ignored.

transformedSrc

@Deprecated
public Storefront.ImageQuery transformedSrc(Storefront.ImageQuery.TransformedSrcArgumentsDefinition argsDef)

Deprecated. Use `url(transform:)` instead

The location of the transformed image as a URL. All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. Otherwise any transformations which an image type doesn't support will be ignored.

url

public Storefront.ImageQuery url()

The location of the image as a URL. If no transform options are specified, then the original image will be preserved including any pre-applied transforms. All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).

url

public Storefront.ImageQuery url(Storefront.ImageQuery.UrlArgumentsDefinition argsDef)

The location of the image as a URL. If no transform options are specified, then the original image will be preserved including any pre-applied transforms. All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).

width

public Storefront.ImageQuery width()

The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.