Interface YearsApiGetYearsRequest

Request parameters for getYears operation in YearsApi.

Export

YearsApiGetYearsRequest

interface YearsApiGetYearsRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    excludeItemTypes?: BaseItemKind[];
    fields?: ItemFields[];
    imageTypeLimit?: number;
    includeItemTypes?: BaseItemKind[];
    limit?: number;
    mediaTypes?: MediaType[];
    parentId?: string;
    recursive?: boolean;
    sortBy?: ItemSortBy[];
    sortOrder?: SortOrder[];
    startIndex?: number;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableUserData? excludeItemTypes? fields? imageTypeLimit? includeItemTypes? limit? mediaTypes? parentId? recursive? sortBy? sortOrder? startIndex? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

YearsApiGetYears

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

YearsApiGetYears

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

YearsApiGetYears

Optional ReadonlyexcludeItemTypes

excludeItemTypes?: BaseItemKind[]

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

Memberof

YearsApiGetYears

Optional Readonlyfields

fields?: ItemFields[]

Optional. Specify additional fields of information to return in the output.

Memberof

YearsApiGetYears

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

Optional. The max number of images to return, per image type.

Memberof

YearsApiGetYears

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

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

Memberof

YearsApiGetYears

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

YearsApiGetYears

Optional ReadonlymediaTypes

mediaTypes?: MediaType[]

Optional. Filter by MediaType. Allows multiple, comma delimited.

Memberof

YearsApiGetYears

Optional ReadonlyparentId

parentId?: string

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

Memberof

YearsApiGetYears

Optional Readonlyrecursive

recursive?: boolean

Search recursively.

Memberof

YearsApiGetYears

Optional ReadonlysortBy

sortBy?: ItemSortBy[]

Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

Memberof

YearsApiGetYears

Optional ReadonlysortOrder

sortOrder?: SortOrder[]

Sort Order - Ascending,Descending.

Memberof

YearsApiGetYears

Optional ReadonlystartIndex

startIndex?: number

Skips over a given number of items within the results. Use for paging.

Memberof

YearsApiGetYears

Optional ReadonlyuserId

userId?: string

User Id.

Memberof

YearsApiGetYears

Settings

Member Visibility

On This Page

Properties