CategoryTreeQuery (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

java.lang.Object
- com.shopify.graphql.support.AbstractQuery<CategoryTreeQuery>
- - com.adobe.cq.commerce.magento.graphql.CategoryTreeQuery

public class CategoryTreeQuery
extends AbstractQuery<CategoryTreeQuery>

Category Tree implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CategoryTreeQuery.ProductsArguments

static interface CategoryTreeQuery.ProductsArgumentsDefinition

Nested Classes
Modifier and Type	Class and Description
`class`	`CategoryTreeQuery.ProductsArguments`
`static interface`	`CategoryTreeQuery.ProductsArgumentsDefinition`

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractQuery
  _queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CategoryTreeQuery`	`addCategoryInterfaceFragmentReference(Fragment<CategoryInterfaceQuery> fragment)` Adds a `CategoryInterfaceQuery` fragment reference at the current position of the query.
`CategoryTreeQuery`	`addFragmentReference(Fragment<CategoryTreeQuery> fragment)` Adds a `CategoryTreeQuery` fragment reference at the current position of the query.
`CategoryTreeQuery`	`automaticSorting()`
`CategoryTreeQuery`	`availableSortBy()`
`CategoryTreeQuery`	`breadcrumbs(BreadcrumbQueryDefinition queryDef)` Breadcrumbs, parent categories info.
`CategoryTreeQuery`	`canonicalUrl()` Relative canonical URL.
`CategoryTreeQuery`	`children(CategoryTreeQueryDefinition queryDef)` Child categories tree.
`CategoryTreeQuery`	`childrenCount()`
`CategoryTreeQuery`	`cmsBlock(CmsBlockQueryDefinition queryDef)` Category CMS Block.
`CategoryTreeQuery`	`createdAt()` Deprecated. The field should not be used on the storefront.
`static Fragment<CategoryTreeQuery>`	`createFragment(String name, CategoryTreeQueryDefinition queryDef)` Creates a GraphQL "named" fragment with the specified query type definition.
`CategoryTreeQuery`	`customLayoutUpdateFile()`
`CategoryTreeQuery`	`defaultSortBy()` The attribute to use for sorting.
`CategoryTreeQuery`	`description()` An optional description of the category.
`CategoryTreeQuery`	`displayMode()`
`CategoryTreeQuery`	`filterPriceRange()`
`CategoryTreeQuery`	`id()` Deprecated. Use the `uid` argument instead.
`CategoryTreeQuery`	`image()`
`CategoryTreeQuery`	`includeInMenu()`
`CategoryTreeQuery`	`isAnchor()`
`CategoryTreeQuery`	`landingPage()`
`CategoryTreeQuery`	`level()` Indicates the depth of the category within the tree.
`CategoryTreeQuery`	`metaDescription()`
`CategoryTreeQuery`	`metaKeywords()`
`CategoryTreeQuery`	`metaTitle()`
`CategoryTreeQuery`	`name()` The display name of the category.
`CategoryTreeQuery`	`path()` Category Path.
`CategoryTreeQuery`	`pathInStore()` Category path in store.
`CategoryTreeQuery`	`position()` The position of the category relative to other categories at the same level in tree.
`CategoryTreeQuery`	`productCount()` The number of products in the category that are marked as visible.
`CategoryTreeQuery`	`products(CategoryProductsQueryDefinition queryDef)` The list of products assigned to the category.
`CategoryTreeQuery`	`products(CategoryTreeQuery.ProductsArgumentsDefinition argsDef, CategoryProductsQueryDefinition queryDef)` The list of products assigned to the category.
`CategoryTreeQuery`	`staged()`
`CategoryTreeQuery`	`uid()` The unique ID for a `CategoryInterface` object.
`CategoryTreeQuery`	`updatedAt()` Deprecated. The field should not be used on the storefront.
`CategoryTreeQuery`	`urlKey()` The url key assigned to the category.
`CategoryTreeQuery`	`urlPath()` The url path assigned to the category.
`CategoryTreeQuery`	`urlSuffix()` The part of the category URL that is appended after the url key

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
  - automaticSorting
```
public CategoryTreeQuery automaticSorting()
```
  - availableSortBy
```
public CategoryTreeQuery availableSortBy()
```
  - breadcrumbs
```
public CategoryTreeQuery breadcrumbs(BreadcrumbQueryDefinition queryDef)
```
    Breadcrumbs, parent categories info.
  - canonicalUrl
```
public CategoryTreeQuery canonicalUrl()
```
    Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled
  - children
```
public CategoryTreeQuery children(CategoryTreeQueryDefinition queryDef)
```
    Child categories tree.
  - childrenCount
```
public CategoryTreeQuery childrenCount()
```
  - cmsBlock
```
public CategoryTreeQuery cmsBlock(CmsBlockQueryDefinition queryDef)
```
    Category CMS Block.
  - createdAt
```
@Deprecated
public CategoryTreeQuery createdAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the category was created.
  - customLayoutUpdateFile
```
public CategoryTreeQuery customLayoutUpdateFile()
```
  - defaultSortBy
```
public CategoryTreeQuery defaultSortBy()
```
    The attribute to use for sorting.
  - description
```
public CategoryTreeQuery description()
```
    An optional description of the category.
  - displayMode
```
public CategoryTreeQuery displayMode()
```
  - filterPriceRange
```
public CategoryTreeQuery filterPriceRange()
```
  - id
```
@Deprecated
public CategoryTreeQuery id()
```
    Deprecated. Use the `uid` argument instead.
    
    An ID that uniquely identifies the category.
  - image
```
public CategoryTreeQuery image()
```
  - includeInMenu
```
public CategoryTreeQuery includeInMenu()
```
  - isAnchor
```
public CategoryTreeQuery isAnchor()
```
  - landingPage
```
public CategoryTreeQuery landingPage()
```
  - level
```
public CategoryTreeQuery level()
```
    Indicates the depth of the category within the tree.
  - metaDescription
```
public CategoryTreeQuery metaDescription()
```
  - metaKeywords
```
public CategoryTreeQuery metaKeywords()
```
  - metaTitle
```
public CategoryTreeQuery metaTitle()
```
  - name
```
public CategoryTreeQuery name()
```
    The display name of the category.
  - path
```
public CategoryTreeQuery path()
```
    Category Path.
  - pathInStore
```
public CategoryTreeQuery pathInStore()
```
    Category path in store.
  - position
```
public CategoryTreeQuery position()
```
    The position of the category relative to other categories at the same level in tree.
  - productCount
```
public CategoryTreeQuery productCount()
```
    The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
  - products
```
public CategoryTreeQuery products(CategoryProductsQueryDefinition queryDef)
```
    The list of products assigned to the category.
  - products
```
public CategoryTreeQuery products(CategoryTreeQuery.ProductsArgumentsDefinition argsDef,
                                  CategoryProductsQueryDefinition queryDef)
```
    The list of products assigned to the category.
  - staged
```
public CategoryTreeQuery staged()
```
  - uid
```
public CategoryTreeQuery uid()
```
    The unique ID for a `CategoryInterface` object.
  - updatedAt
```
@Deprecated
public CategoryTreeQuery updatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the category was updated.
  - urlKey
```
public CategoryTreeQuery urlKey()
```
    The url key assigned to the category.
  - urlPath
```
public CategoryTreeQuery urlPath()
```
    The url path assigned to the category.
  - urlSuffix
```
public CategoryTreeQuery urlSuffix()
```
    The part of the category URL that is appended after the url key
  - createFragment
```
public static Fragment<CategoryTreeQuery> createFragment(String name,
                                                         CategoryTreeQueryDefinition 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 CategoryTreeQuery addFragmentReference(Fragment<CategoryTreeQuery> fragment)
```
    Adds a CategoryTreeQuery 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.
  - addCategoryInterfaceFragmentReference
```
public CategoryTreeQuery addCategoryInterfaceFragmentReference(Fragment<CategoryInterfaceQuery> fragment)
```
    Adds a CategoryInterfaceQuery 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.
    
    Parameters:
    
    fragment - The fragment to reference.

Class CategoryTreeQuery

Nested Class Summary

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

automaticSorting

availableSortBy

breadcrumbs

canonicalUrl

children

childrenCount

cmsBlock

createdAt

customLayoutUpdateFile

defaultSortBy

description

displayMode

filterPriceRange

id

image

includeInMenu

isAnchor

landingPage

level

metaDescription

metaKeywords

metaTitle

name

path

pathInStore

position

productCount

products

products

staged

uid

updatedAt

urlKey

urlPath

urlSuffix

createFragment

addFragmentReference

addCategoryInterfaceFragmentReference