com.shopify.buy3

Class Storefront.ApiVersionQuery

java.lang.Object

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

com.shopify.buy3.Storefront.ApiVersionQuery

Enclosing class:

Storefront

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

A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`).

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.ApiVersionQuery	displayName() The human-readable name of the version.
Storefront.ApiVersionQuery	handle() The unique identifier of an ApiVersion.
Storefront.ApiVersionQuery	supported() Whether the version is actively supported by Shopify.

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

displayName

public Storefront.ApiVersionQuery displayName()

The human-readable name of the version.

handle

public Storefront.ApiVersionQuery handle()

The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.

supported

public Storefront.ApiVersionQuery supported()

Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning).