Interface SuggestionsApiGetSuggestionsRequest

Request parameters for getSuggestions operation in SuggestionsApi.

Export

SuggestionsApiGetSuggestionsRequest

interface SuggestionsApiGetSuggestionsRequest {
    enableTotalRecordCount?: boolean;
    limit?: number;
    mediaType?: MediaType[];
    startIndex?: number;
    type?: BaseItemKind[];
    userId?: string;
}

Properties

enableTotalRecordCount? limit? mediaType? startIndex? type? userId?

Properties

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Whether to enable the total record count.

Memberof

SuggestionsApiGetSuggestions

Optional Readonlylimit

limit?: number

Optional. The limit.

Memberof

SuggestionsApiGetSuggestions

Optional ReadonlymediaType

mediaType?: MediaType[]

The media types.

Memberof

SuggestionsApiGetSuggestions

Optional ReadonlystartIndex

startIndex?: number

Optional. The start index.

Memberof

SuggestionsApiGetSuggestions

Optional Readonlytype

type?: BaseItemKind[]

The type.

Memberof

SuggestionsApiGetSuggestions

Optional ReadonlyuserId

userId?: string

The user id.

Memberof

SuggestionsApiGetSuggestions

Settings

Member Visibility

On This Page

Properties