PageType Object

Represents a type of page. It defines what attributes are available to pages of this type.

type PageType implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  name: String!
  slug: String!
  attributes: [Attribute!]
  availableAttributes(
    filter: AttributeFilterInput
    where: AttributeWhereInput
    before: String
    after: String
    first: Int
    last: Int
  ): AttributeCountableConnection
  hasPages: Boolean
}

Expand ▼

Fields

PageType.id ● ID! non-null scalar miscellaneous

ID of the page type.

PageType.privateMetadata ● [MetadataItem!]! non-null object miscellaneous

List of private metadata items. Requires staff permissions to access.

PageType.privateMetafield ● String scalar miscellaneous

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

PageType.privateMetafield.key ● String! non-null scalar miscellaneous

PageType.privateMetafields ● Metadata scalar miscellaneous

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

PageType.privateMetafields.keys ● [String!] list scalar miscellaneous

PageType.metadata ● [MetadataItem!]! non-null object miscellaneous

List of public metadata items. Can be accessed without permissions.

PageType.metafield ● String scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

PageType.metafield.key ● String! non-null scalar miscellaneous

PageType.metafields ● Metadata scalar miscellaneous

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

PageType.metafields.keys ● [String!] list scalar miscellaneous

PageType.name ● String! non-null scalar miscellaneous

Name of the page type.

PageType.slug ● String! non-null scalar miscellaneous

Slug of the page type.

PageType.attributes ● [Attribute!] list object attributes

Page attributes of that page type.

PageType.availableAttributes ● AttributeCountableConnection object attributes

Attributes that can be assigned to the page type.

Requires one of the following permissions: MANAGE_PAGESMANAGE_PAGE_TYPES_AND_ATTRIBUTES

PageType.availableAttributes.filter ● AttributeFilterInput input attributes

PageType.availableAttributes.where ● AttributeWhereInput input attributes

PageType.availableAttributes.before ● String scalar miscellaneous

Return the elements in the list that come before the specified cursor.

PageType.availableAttributes.after ● String scalar miscellaneous

Return the elements in the list that come after the specified cursor.

PageType.availableAttributes.first ● Int scalar miscellaneous

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

PageType.availableAttributes.last ● Int scalar miscellaneous

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

PageType.hasPages ● Boolean scalar miscellaneous

Whether page type has pages assigned.

Requires one of the following permissions: MANAGE_PAGESMANAGE_PAGE_TYPES_AND_ATTRIBUTES

Interfaces

Node interface miscellaneous

An object with an ID

ObjectWithMetadata interface miscellaneous

Returned By

pageType query

Member Of

Page object ● PageAttributeAssign object ● PageAttributeUnassign object ● PageTypeCountableEdge object ● PageTypeCreate object ● PageTypeCreated object ● PageTypeDelete object ● PageTypeDeleted object ● PageTypeReorderAttributes object ● PageTypeUpdate object ● PageTypeUpdated object

Implemented By

_Entity union