Package 

Class TvShowsApi

    • Constructor Detail

    • Method Detail

      • getEpisodes

         final Response<BaseItemDtoQueryResult> getEpisodes(UUID seriesId, UUID userId, List<ItemFields> fields, Integer season, UUID seasonId, Boolean isMissing, String adjacentTo, UUID startItemId, Integer startIndex, Integer limit, Boolean enableImages, Integer imageTypeLimit, List<ImageType> enableImageTypes, Boolean enableUserData, String sortBy)

        Gets episodes for a tv season.

        Parameters:
        seriesId - The series id.
        userId - The user id.
        fields - Optional.
        season - Optional filter by season number.
        seasonId - Optional.
        isMissing - Optional.
        adjacentTo - Optional.
        startItemId - Optional.
        startIndex - Optional.
        limit - Optional.
        enableImages - Optional, include image information in output.
        imageTypeLimit - Optional, the max number of images to return, per image type.
        enableImageTypes - Optional.
        enableUserData - Optional.
        sortBy - Optional.

      • getNextUp

         final Response<BaseItemDtoQueryResult> getNextUp(UUID userId, Integer startIndex, Integer limit, List<ItemFields> fields, String seriesId, UUID parentId, Boolean enableImges, Integer imageTypeLimit, List<ImageType> enableImageTypes, Boolean enableUserData, Boolean enableTotalRecordCount, Boolean disableFirstEpisode)

        Gets a list of next up episodes.

        Parameters:
        userId - The user id of the user to get the next up episodes for.
        startIndex - Optional.
        limit - Optional.
        fields - Optional.
        seriesId - Optional.
        parentId - Optional.
        enableImges - Optional.
        imageTypeLimit - Optional.
        enableImageTypes - Optional.
        enableUserData - Optional.
        enableTotalRecordCount - Whether to enable the total records count.
        disableFirstEpisode - Whether to disable sending the first episode in a series as next up.

      • getSeasons

         final Response<BaseItemDtoQueryResult> getSeasons(UUID seriesId, UUID userId, List<ItemFields> fields, Boolean isSpecialSeason, Boolean isMissing, String adjacentTo, Boolean enableImages, Integer imageTypeLimit, List<ImageType> enableImageTypes, Boolean enableUserData)

        Gets seasons for a tv series.

        Parameters:
        seriesId - The series id.
        userId - The user id.
        fields - Optional.
        isSpecialSeason - Optional.
        isMissing - Optional.
        adjacentTo - Optional.
        enableImages - Optional.
        imageTypeLimit - Optional.
        enableImageTypes - Optional.
        enableUserData - Optional.

      • getUpcomingEpisodes

         final Response<BaseItemDtoQueryResult> getUpcomingEpisodes(UUID userId, Integer startIndex, Integer limit, List<ItemFields> fields, UUID parentId, Boolean enableImges, Integer imageTypeLimit, List<ImageType> enableImageTypes, Boolean enableUserData)

        Gets a list of upcoming episodes.

        Parameters:
        userId - The user id of the user to get the upcoming episodes for.
        startIndex - Optional.
        limit - Optional.
        fields - Optional.
        parentId - Optional.
        enableImges - Optional.
        imageTypeLimit - Optional.
        enableImageTypes - Optional.
        enableUserData - Optional.