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

    Type Alias GetRecommendedProgramsData

    type GetRecommendedProgramsData = {
        body?: never;
        path?: never;
        query?: {
            userId?: string;
            startIndex?: number;
            limit?: number;
            isAiring?: boolean;
            hasAired?: boolean;
            isSeries?: boolean;
            isMovie?: boolean;
            isNews?: boolean;
            isKids?: boolean;
            isSports?: boolean;
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            genreIds?: string[];
            fields?: ItemFields[];
            enableUserData?: boolean;
            enableTotalRecordCount?: boolean;
        };
        url: "/LiveTv/Programs/Recommended";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        userId?: string;
        startIndex?: number;
        limit?: number;
        isAiring?: boolean;
        hasAired?: boolean;
        isSeries?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isKids?: boolean;
        isSports?: boolean;
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        genreIds?: string[];
        fields?: ItemFields[];
        enableUserData?: boolean;
        enableTotalRecordCount?: boolean;
    }

    Type Declaration

    • OptionaluserId?: string

      Optional. filter by user id.

    • 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.

    • OptionalisAiring?: boolean

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

    • OptionalhasAired?: boolean

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

    • OptionalisSeries?: boolean

      Optional. Filter for series.

    • OptionalisMovie?: boolean

      Optional. Filter for movies.

    • OptionalisNews?: boolean

      Optional. Filter for news.

    • OptionalisKids?: boolean

      Optional. Filter for kids.

    • OptionalisSports?: boolean

      Optional. Filter for sports.

    • 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.

    • OptionalgenreIds?: string[]

      The genres to return guide information for.

    • Optionalfields?: ItemFields[]

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

    • OptionalenableUserData?: boolean

      Optional. include user data.

    • OptionalenableTotalRecordCount?: boolean

      Retrieve total record count.

    url: "/LiveTv/Programs/Recommended"

    Settings
    Member Visibility

    On This Page
    Properties