Storefront.Image (buy3 18.0.0 API)

java.lang.Object
- com.shopify.graphql.support.AbstractResponse<Storefront.Image>
- - com.shopify.buy3.Storefront.Image

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Storefront
```
public static class Storefront.Image
extends AbstractResponse<Storefront.Image>
```
Represents an image resource.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

Constructor Summary

Constructors
Constructor and Description

Image()

Image(JsonObject fields)

Constructors
Constructor and Description
`Image()`
`Image(JsonObject fields)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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 ID for the image.
`java.lang.String`	`getOriginalSrc()` Deprecated. Use `url` instead.
`java.lang.String`	`getSrc()` Deprecated. Use `url` instead.
`java.lang.String`	`getTransformedSrc()` Deprecated. Use `url(transform:)` instead
`java.lang.String`	`getUrl()` The location of the 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`	`setUrl(java.lang.String arg)`
`Storefront.Image`	`setWidth(java.lang.Integer arg)`
`boolean`	`unwrapsToObject(java.lang.String key)`

Methods inherited from class com.shopify.graphql.support.AbstractResponse
collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

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 isn't hosted by Shopify.
  - setHeight
```
public Storefront.Image setHeight(java.lang.Integer arg)
```
  - getId
```
public ID getId()
```
    A unique ID for the image.
  - setId
```
public Storefront.Image setId(ID arg)
```
  - getOriginalSrc
```
public java.lang.String getOriginalSrc()
```
    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.
  - setOriginalSrc
```
public Storefront.Image setOriginalSrc(java.lang.String arg)
```
  - getSrc
```
public java.lang.String getSrc()
```
    Deprecated. Use `url` instead.
    
    The location of the image as a URL.
  - setSrc
```
public Storefront.Image setSrc(java.lang.String arg)
```
  - getTransformedSrc
```
public java.lang.String getTransformedSrc()
```
    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.
  - setTransformedSrc
```
public Storefront.Image setTransformedSrc(java.lang.String arg)
```
  - getUrl
```
public java.lang.String getUrl()
```
    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).
  - setUrl
```
public Storefront.Image setUrl(java.lang.String arg)
```
  - getWidth
```
public java.lang.Integer getWidth()
```
    The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.
  - setWidth
```
public Storefront.Image setWidth(java.lang.Integer arg)
```
  - unwrapsToObject
```
public boolean unwrapsToObject(java.lang.String key)
```
    Specified by:
    
    unwrapsToObject in class AbstractResponse<Storefront.Image>

Class Storefront.Image

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Image

Image

Method Detail

getGraphQlTypeName

getAltText

setAltText

getHeight

setHeight

getId

setId

getOriginalSrc

setOriginalSrc

getSrc

setSrc

getTransformedSrc

setTransformedSrc

getUrl

setUrl

getWidth

setWidth

unwrapsToObject