@jellyfin/sdk
    Preparing search index...

    Interface GetProgramsDto

    Get programs dto.

    GetProgramsDto

    interface GetProgramsDto {
        ChannelIds?: null | string[];
        EnableImages?: null | boolean;
        EnableImageTypes?: null | ImageType[];
        EnableTotalRecordCount?: boolean;
        EnableUserData?: null | boolean;
        Fields?: null | ItemFields[];
        GenreIds?: null | string[];
        Genres?: null | string[];
        HasAired?: null | boolean;
        ImageTypeLimit?: null | number;
        IsAiring?: null | boolean;
        IsKids?: null | boolean;
        IsMovie?: null | boolean;
        IsNews?: null | boolean;
        IsSeries?: null | boolean;
        IsSports?: null | boolean;
        LibrarySeriesId?: null | string;
        Limit?: null | number;
        MaxEndDate?: null | string;
        MaxStartDate?: null | string;
        MinEndDate?: null | string;
        MinStartDate?: null | string;
        SeriesTimerId?: null | string;
        SortBy?: null | ItemSortBy[];
        SortOrder?: null | SortOrder[];
        StartIndex?: null | number;
        UserId?: null | string;
    }
    Index

    Properties

    ChannelIds? EnableImages? EnableImageTypes? EnableTotalRecordCount? EnableUserData? Fields? GenreIds? Genres? HasAired? ImageTypeLimit? IsAiring? IsKids? IsMovie? IsNews? IsSeries? IsSports? LibrarySeriesId? Limit? MaxEndDate? MaxStartDate? MinEndDate? MinStartDate? SeriesTimerId? SortBy? SortOrder? StartIndex? UserId?

    Properties

    ChannelIds?: null | string[]

    Gets or sets the channels to return guide information for.

    GetProgramsDto

    EnableImages?: null | boolean

    Gets or sets include image information in output.

    GetProgramsDto

    EnableImageTypes?: null | ImageType[]

    Gets or sets the image types to include in the output.

    GetProgramsDto

    EnableTotalRecordCount?: boolean

    Gets or sets a value indicating whether retrieve total record count.

    GetProgramsDto

    EnableUserData?: null | boolean

    Gets or sets include user data.

    GetProgramsDto

    Fields?: null | ItemFields[]

    Gets or sets specify additional fields of information to return in the output.

    GetProgramsDto

    GenreIds?: null | string[]

    Gets or sets the genre ids to return guide information for.

    GetProgramsDto

    Genres?: null | string[]

    Gets or sets the genres to return guide information for.

    GetProgramsDto

    HasAired?: null | boolean

    Gets or sets filter by programs that have completed airing, or not.

    GetProgramsDto

    ImageTypeLimit?: null | number

    Gets or sets the max number of images to return, per image type.

    GetProgramsDto

    IsAiring?: null | boolean

    Gets or sets filter by programs that are currently airing, or not.

    GetProgramsDto

    IsKids?: null | boolean

    Gets or sets filter for kids.

    GetProgramsDto

    IsMovie?: null | boolean

    Gets or sets filter for movies.

    GetProgramsDto

    IsNews?: null | boolean

    Gets or sets filter for news.

    GetProgramsDto

    IsSeries?: null | boolean

    Gets or sets filter for series.

    GetProgramsDto

    IsSports?: null | boolean

    Gets or sets filter for sports.

    GetProgramsDto

    LibrarySeriesId?: null | string

    Gets or sets filter by library series id.

    GetProgramsDto

    Limit?: null | number

    Gets or sets the maximum number of records to return.

    GetProgramsDto

    MaxEndDate?: null | string

    Gets or sets the maximum premiere end date.

    GetProgramsDto

    MaxStartDate?: null | string

    Gets or sets the maximum premiere start date.

    GetProgramsDto

    MinEndDate?: null | string

    Gets or sets the minimum premiere end date.

    GetProgramsDto

    MinStartDate?: null | string

    Gets or sets the minimum premiere start date.

    GetProgramsDto

    SeriesTimerId?: null | string

    Gets or sets filter by series timer id.

    GetProgramsDto

    SortBy?: null | ItemSortBy[]

    Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.

    GetProgramsDto

    SortOrder?: null | SortOrder[]

    Gets or sets sort order.

    GetProgramsDto

    StartIndex?: null | number

    Gets or sets the record index to start at. All items with a lower index will be dropped from the results.

    GetProgramsDto

    UserId?: null | string

    Gets or sets optional. Filter by user id.

    GetProgramsDto

    Settings

    Member Visibility

    On This Page

    Properties