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

All Superinterfaces:

CustomFieldInterface

All Known Implementing Classes:

CategoryTree, UnknownCategoryInterface
```
public interface CategoryInterface
extends CustomFieldInterface
```
CategoryInterface contains the full set of attributes that can be returned in a category search.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAutomaticSorting()`
`List<String>`	`getAvailableSortBy()`
`List<Breadcrumb>`	`getBreadcrumbs()` Breadcrumbs, parent categories info.
`String`	`getCanonicalUrl()` Relative canonical URL.
`String`	`getChildrenCount()`
`CmsBlock`	`getCmsBlock()` Category CMS Block.
`String`	`getCreatedAt()` Deprecated. The field should not be used on the storefront.
`String`	`getCustomLayoutUpdateFile()`
`String`	`getDefaultSortBy()` The attribute to use for sorting.
`String`	`getDescription()` An optional description of the category.
`String`	`getDisplayMode()`
`Double`	`getFilterPriceRange()`
`String`	`getGraphQlTypeName()`
`Integer`	`getId()` Deprecated. Use the `uid` argument instead.
`String`	`getImage()`
`Integer`	`getIncludeInMenu()`
`Integer`	`getIsAnchor()`
`Integer`	`getLandingPage()`
`Integer`	`getLevel()` Indicates the depth of the category within the tree.
`String`	`getMetaDescription()`
`String`	`getMetaKeywords()`
`String`	`getMetaTitle()`
`String`	`getName()` The display name of the category.
`String`	`getPath()` Category Path.
`String`	`getPathInStore()` Category path in store.
`Integer`	`getPosition()` The position of the category relative to other categories at the same level in tree.
`Integer`	`getProductCount()` The number of products in the category that are marked as visible.
`CategoryProducts`	`getProducts()` The list of products assigned to the category.
`Boolean`	`getStaged()`
`ID`	`getUid()` The unique ID for a `CategoryInterface` object.
`String`	`getUpdatedAt()` Deprecated. The field should not be used on the storefront.
`String`	`getUrlKey()` The url key assigned to the category.
`String`	`getUrlPath()` The url path assigned to the category.
`String`	`getUrlSuffix()` The part of the category URL that is appended after the url key

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface
get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString

- Method Detail
  - getGraphQlTypeName
```
String getGraphQlTypeName()
```
  - getAutomaticSorting
```
String getAutomaticSorting()
```
  - getAvailableSortBy
```
List<String> getAvailableSortBy()
```
  - getBreadcrumbs
```
List<Breadcrumb> getBreadcrumbs()
```
    Breadcrumbs, parent categories info.
  - getCanonicalUrl
```
String getCanonicalUrl()
```
    Relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled
  - getChildrenCount
```
String getChildrenCount()
```
  - getCmsBlock
```
CmsBlock getCmsBlock()
```
    Category CMS Block.
  - getCreatedAt
```
@Deprecated
String getCreatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the category was created.
  - getCustomLayoutUpdateFile
```
String getCustomLayoutUpdateFile()
```
  - getDefaultSortBy
```
String getDefaultSortBy()
```
    The attribute to use for sorting.
  - getDescription
```
String getDescription()
```
    An optional description of the category.
  - getDisplayMode
```
String getDisplayMode()
```
  - getFilterPriceRange
```
Double getFilterPriceRange()
```
  - getId
```
@Deprecated
Integer getId()
```
    Deprecated. Use the `uid` argument instead.
    
    An ID that uniquely identifies the category.
  - getImage
```
String getImage()
```
  - getIncludeInMenu
```
Integer getIncludeInMenu()
```
  - getIsAnchor
```
Integer getIsAnchor()
```
  - getLandingPage
```
Integer getLandingPage()
```
  - getLevel
```
Integer getLevel()
```
    Indicates the depth of the category within the tree.
  - getMetaDescription
```
String getMetaDescription()
```
  - getMetaKeywords
```
String getMetaKeywords()
```
  - getMetaTitle
```
String getMetaTitle()
```
  - getName
```
String getName()
```
    The display name of the category.
  - getPath
```
String getPath()
```
    Category Path.
  - getPathInStore
```
String getPathInStore()
```
    Category path in store.
  - getPosition
```
Integer getPosition()
```
    The position of the category relative to other categories at the same level in tree.
  - getProductCount
```
Integer getProductCount()
```
    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.
  - getProducts
```
CategoryProducts getProducts()
```
    The list of products assigned to the category.
  - getStaged
```
Boolean getStaged()
```
  - getUid
```
ID getUid()
```
    The unique ID for a `CategoryInterface` object.
  - getUpdatedAt
```
@Deprecated
String getUpdatedAt()
```
    Deprecated. The field should not be used on the storefront.
    
    Timestamp indicating when the category was updated.
  - getUrlKey
```
String getUrlKey()
```
    The url key assigned to the category.
  - getUrlPath
```
String getUrlPath()
```
    The url path assigned to the category.
  - getUrlSuffix
```
String getUrlSuffix()
```
    The part of the category URL that is appended after the url key

Interface CategoryInterface

Method Summary

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface

Method Detail

getGraphQlTypeName

getAutomaticSorting

getAvailableSortBy

getBreadcrumbs

getCanonicalUrl

getChildrenCount

getCmsBlock

getCreatedAt

getCustomLayoutUpdateFile

getDefaultSortBy

getDescription

getDisplayMode

getFilterPriceRange

getId

getImage

getIncludeInMenu

getIsAnchor

getLandingPage

getLevel

getMetaDescription

getMetaKeywords

getMetaTitle

getName

getPath

getPathInStore

getPosition

getProductCount

getProducts

getStaged

getUid

getUpdatedAt

getUrlKey

getUrlPath

getUrlSuffix