Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetLiveTvProgramsData

    type GetLiveTvProgramsData = {
        body?: never;
        path?: never;
        query?: {
            channelIds?: string[];
            userId?: string;
            minStartDate?: string;
            hasAired?: boolean;
            isAiring?: boolean;
            maxStartDate?: string;
            minEndDate?: string;
            maxEndDate?: string;
            isMovie?: boolean;
            isSeries?: boolean;
            isNews?: boolean;
            isKids?: boolean;
            isSports?: boolean;
            startIndex?: number;
            limit?: number;
            sortBy?: ItemSortBy[];
            sortOrder?: SortOrder[];
            genres?: string[];
            genreIds?: string[];
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            enableUserData?: boolean;
            seriesTimerId?: string;
            librarySeriesId?: string;
            fields?: ItemFields[];
            enableTotalRecordCount?: boolean;
        };
        url: "/LiveTv/Programs";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        channelIds?: string[];
        userId?: string;
        minStartDate?: string;
        hasAired?: boolean;
        isAiring?: boolean;
        maxStartDate?: string;
        minEndDate?: string;
        maxEndDate?: string;
        isMovie?: boolean;
        isSeries?: boolean;
        isNews?: boolean;
        isKids?: boolean;
        isSports?: boolean;
        startIndex?: number;
        limit?: number;
        sortBy?: ItemSortBy[];
        sortOrder?: SortOrder[];
        genres?: string[];
        genreIds?: string[];
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        seriesTimerId?: string;
        librarySeriesId?: string;
        fields?: ItemFields[];
        enableTotalRecordCount?: boolean;
    }

    Type Declaration

    • OptionalchannelIds?: string[]

      The channels to return guide information for.

    • OptionaluserId?: string

      Optional. Filter by user id.

    • OptionalminStartDate?: string

      Optional. The minimum premiere start date.

    • OptionalhasAired?: boolean

      Optional. Filter by programs that have completed airing, or not.

    • OptionalisAiring?: boolean

      Optional. Filter by programs that are currently airing, or not.

    • OptionalmaxStartDate?: string

      Optional. The maximum premiere start date.

    • OptionalminEndDate?: string

      Optional. The minimum premiere end date.

    • OptionalmaxEndDate?: string

      Optional. The maximum premiere end date.

    • OptionalisMovie?: boolean

      Optional. Filter for movies.

    • OptionalisSeries?: boolean

      Optional. Filter for series.

    • OptionalisNews?: boolean

      Optional. Filter for news.

    • OptionalisKids?: boolean

      Optional. Filter for kids.

    • OptionalisSports?: boolean

      Optional. Filter for sports.

    • OptionalstartIndex?: number

      Optional. The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • OptionalsortBy?: ItemSortBy[]

      Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.

    • OptionalsortOrder?: SortOrder[]

      Sort Order - Ascending,Descending.

    • Optionalgenres?: string[]

      The genres to return guide information for.

    • OptionalgenreIds?: string[]

      The genre ids to return guide information for.

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

    • OptionalimageTypeLimit?: number

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

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • OptionalenableUserData?: boolean

      Optional. Include user data.

    • OptionalseriesTimerId?: string

      Optional. Filter by series timer id.

    • OptionallibrarySeriesId?: string

      Optional. Filter by library series id.

    • Optionalfields?: ItemFields[]

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

    • OptionalenableTotalRecordCount?: boolean

      Retrieve total record count.

    url: "/LiveTv/Programs"

    Settings
    Member Visibility

    On This Page
    Properties