PinItem

Version:

Type	Interface
Import path	`@sitecore-cloudsdk/search/server`

Pin rules for a search request. Used to force a single item or category to appear in a specific slot even if it is not in the natural results set for a request.

To force a list of items or categories to appear in fixed slots, use Include.

Signature

interface PinItem {
  id: string;
  slot: number;
}

Properties

Name	Type	Description	Value
`id`	`string`	Required. The ID of the item to pin.	N/A
`slot`	`integer`	Required. A position in a list of search results to which you can apply pin, include, or boost rules.	`4`

Name

Type

Description

Value

id

string

Required.

The ID of the item to pin.

N/A

slot

integer

Required.

A position in a list of search results to which you can apply pin, include, or boost rules.

4

If you have suggestions for improving this article, let us know!