Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContentClientHierarchyRequest

wrapping object for the content client request

member

rootId the deliveryId of the root item

member

rootItem (optional) to pass the root item if it has already been fetched

member

maximumDepth (optional) specifies the maximum depth of the hierarchy query

member

maximumPageSize (optional) specifies the maximum page size for each page of the hierarchy,

member

sortOrder (optional) specifies the sort the service should use when retrieving content from the database

member

sortKey (optional) specifies the name of the sort parameter used to retrieve content, this can effect what content is returned note: maximumDepth and maximumPageSize will not override the limits set by the delivery service.

Hierarchy

Index

Properties

Optional maximumDepth

maximumDepth: number

Optional maximumPageSize

maximumPageSize: number

Optional rootItem

rootItem: ContentItem

Optional sortKey

sortKey: string

Optional sortOrder

sortOrder: IOrder

Generated using TypeDoc