@jellyfin/sdk
    Preparing search index...

    Function FilterApiFp

    • FilterApi - functional programming interface

      Parameters

      Returns {
          getQueryFilters(
              userId?: string,
              parentId?: string,
              includeItemTypes?: BaseItemKind[],
              isAiring?: boolean,
              isMovie?: boolean,
              isSports?: boolean,
              isKids?: boolean,
              isNews?: boolean,
              isSeries?: boolean,
              recursive?: boolean,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<QueryFilters>,
          >;
          getQueryFiltersLegacy(
              userId?: string,
              parentId?: string,
              includeItemTypes?: BaseItemKind[],
              mediaTypes?: MediaType[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<QueryFiltersLegacy>,
          >;
      }

      • getQueryFilters: function
        • Parameters

          • OptionaluserId: string

            Optional. User id.

          • OptionalparentId: string

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

          • OptionalincludeItemTypes: BaseItemKind[]

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

          • OptionalisAiring: boolean

            Optional. Is item airing.

          • OptionalisMovie: boolean

            Optional. Is item movie.

          • OptionalisSports: boolean

            Optional. Is item sports.

          • OptionalisKids: boolean

            Optional. Is item kids.

          • OptionalisNews: boolean

            Optional. Is item news.

          • OptionalisSeries: boolean

            Optional. Is item series.

          • Optionalrecursive: boolean

            Optional. Search recursive.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFilters>,
          >

      • getQueryFiltersLegacy: function
        • Parameters

          • OptionaluserId: string

            Optional. User id.

          • OptionalparentId: string

            Optional. Parent id.

          • OptionalincludeItemTypes: BaseItemKind[]

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

          • OptionalmediaTypes: MediaType[]

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

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<QueryFiltersLegacy>,
          >