com.shopify.buy3

Class Storefront.Image

java.lang.Object

<any>

com.shopify.buy3.Storefront.Image

Enclosing class:

Storefront

public static class Storefront.Image
extends <any>

Represents an image resource.

Constructor Summary

Constructors

Constructor and Description
Image()
Image(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAltText() A word or phrase to share the nature or contents of an image.
java.lang.String	getGraphQlTypeName()
java.lang.Integer	getHeight() The original height of the image in pixels.
ID	getId() A unique identifier for the image.
java.lang.String	getOriginalSrc() The location of the original image as a URL.
java.lang.String	getSrc() Deprecated. Previously an image had a single `src` field. This could either return the original image location or a URL that contained transformations such as sizing or scale. These transformations were specified by arguments on the parent field. Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. `originalSrc` - the original unmodified image URL `transformedSrc` - the image URL with the specified transformations included To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. Before: ```graphql { shop { productImages(maxWidth: 200, scale: 2) { edges { node { src } } } } } ``` After: ```graphql { shop { productImages { edges { node { transformedSrc(maxWidth: 200, scale: 2) } } } } } ```
java.lang.String	getTransformedSrc() The location of the transformed image as a URL.
java.lang.Integer	getWidth() The original width of the image in pixels.
Storefront.Image	setAltText(java.lang.String arg)
Storefront.Image	setHeight(java.lang.Integer arg)
Storefront.Image	setId(ID arg)
Storefront.Image	setOriginalSrc(java.lang.String arg)
Storefront.Image	setSrc(java.lang.String arg)
Storefront.Image	setTransformedSrc(java.lang.String arg)
Storefront.Image	setWidth(java.lang.Integer arg)
boolean	unwrapsToObject(java.lang.String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

Image

public Image()

Image

public Image(JsonObject fields)
      throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

getAltText

public java.lang.String getAltText()

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

setAltText

public Storefront.Image setAltText(java.lang.String arg)

getHeight

public java.lang.Integer getHeight()

The original height of the image in pixels. Returns `null` if the image is not hosted by Shopify.

setHeight

public Storefront.Image setHeight(java.lang.Integer arg)

getId

public ID getId()

A unique identifier for the image.

setId

public Storefront.Image setId(ID arg)

getOriginalSrc

public java.lang.String getOriginalSrc()

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.

setOriginalSrc

public Storefront.Image setOriginalSrc(java.lang.String arg)

getSrc

public java.lang.String getSrc()

Deprecated. Previously an image had a single `src` field. This could either return the original image location or a URL that contained transformations such as sizing or scale. These transformations were specified by arguments on the parent field. Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. `originalSrc` - the original unmodified image URL `transformedSrc` - the image URL with the specified transformations included To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. Before: ```graphql { shop { productImages(maxWidth: 200, scale: 2) { edges { node { src } } } } } ``` After: ```graphql { shop { productImages { edges { node { transformedSrc(maxWidth: 200, scale: 2) } } } } } ```

The location of the image as a URL.

setSrc

public Storefront.Image setSrc(java.lang.String arg)

getTransformedSrc

public java.lang.String getTransformedSrc()

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 does not support will be ignored.

setTransformedSrc

public Storefront.Image setTransformedSrc(java.lang.String arg)

getWidth

public java.lang.Integer getWidth()

The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify.

setWidth

public Storefront.Image setWidth(java.lang.Integer arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)