Interface FilterApiGetQueryFiltersRequest

Request parameters for getQueryFilters operation in FilterApi.

Export

FilterApiGetQueryFiltersRequest

interface FilterApiGetQueryFiltersRequest {
    includeItemTypes?: BaseItemKind[];
    isAiring?: boolean;
    isKids?: boolean;
    isMovie?: boolean;
    isNews?: boolean;
    isSeries?: boolean;
    isSports?: boolean;
    parentId?: string;
    recursive?: boolean;
    userId?: string;
}

Properties

includeItemTypes? isAiring? isKids? isMovie? isNews? isSeries? isSports? parentId? recursive? userId?

Properties

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyisAiring

isAiring?: boolean

Optional. Is item airing.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyisKids

isKids?: boolean

Optional. Is item kids.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyisMovie

isMovie?: boolean

Optional. Is item movie.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyisNews

isNews?: boolean

Optional. Is item news.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyisSeries

isSeries?: boolean

Optional. Is item series.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyisSports

isSports?: boolean

Optional. Is item sports.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyparentId

parentId?: string

Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.

Memberof

FilterApiGetQueryFilters

Optional Readonlyrecursive

recursive?: boolean

Optional. Search recursive.

Memberof

FilterApiGetQueryFilters

Optional ReadonlyuserId

userId?: string

Optional. User id.

Memberof

FilterApiGetQueryFilters

Settings

Member Visibility

On This Page

Properties