@jellyfin/sdk
    Preparing search index...

    Interface YearsApiGetYearsRequest

    Request parameters for getYears operation in YearsApi.

    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;
    }
    Index

    Properties

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

    Properties

    enableImages?: boolean

    Optional. Include image information in output.

    YearsApiGetYears

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    YearsApiGetYears

    enableUserData?: boolean

    Optional. Include user data.

    YearsApiGetYears

    excludeItemTypes?: BaseItemKind[]

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

    YearsApiGetYears

    fields?: ItemFields[]

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

    YearsApiGetYears

    imageTypeLimit?: number

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

    YearsApiGetYears

    includeItemTypes?: BaseItemKind[]

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

    YearsApiGetYears

    limit?: number

    Optional. The maximum number of records to return.

    YearsApiGetYears

    mediaTypes?: MediaType[]

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

    YearsApiGetYears

    parentId?: string

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

    YearsApiGetYears

    recursive?: boolean

    Search recursively.

    YearsApiGetYears

    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.

    YearsApiGetYears

    sortOrder?: SortOrder[]

    Sort Order - Ascending,Descending.

    YearsApiGetYears

    startIndex?: number

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

    YearsApiGetYears

    userId?: string

    User Id.

    YearsApiGetYears

    Settings

    Member Visibility

    On This Page

    Properties