1. @sitecore-cloudsdk/search/server

WidgetRequestData

Version:

Type

Class

Import path

@sitecore-cloudsdk/search/server

Data about the widget or widgets to retrieve.

Constructor

WidgetRequestData(widgetItems: WidgetItem[])

Parameters

Name

Type

Description

widgetItems

WidgetItem[]

Required.

Array of WidgetItem objects that describe each widget to retrieve.

Minimum length: 1.

Properties

Name

Type

Description

_widgetItems

WidgetItem[]

Required.

Array of WidgetItem objects that describe each widget to retrieve.

Minimum length: 1.

Methods

_validateWidgetItems

Validates widget items.

Signature

private _validateWidgetItems(widgetItems: WidgetItem[]): void

Parameters

Name

Type

Description

widgetItems

WidgetItem[]

Required.

Array of WidgetItem objects that describe each widget to retrieve.

Minimum length: 1.

Return value

Returns void.

Errors

toDTO

Maps the widget items to their DTO (data transfer object) format.

Signature

toDTO(): WidgetDTO

Return value

Returns the widget items in a standardized DTO format.

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