Function FilterApiAxiosParamCreator

FilterApi - axios parameter creator

Export

  • FilterApiAxiosParamCreator(configuration?): {
        getQueryFilters: ((userId?: string, parentId?: string, includeItemTypes?: BaseItemKind[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getQueryFiltersLegacy: ((userId?: string, parentId?: string, includeItemTypes?: BaseItemKind[], mediaTypes?: MediaType[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • 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<RequestArgs>);
        getQueryFiltersLegacy: ((userId?: string, parentId?: string, includeItemTypes?: BaseItemKind[], mediaTypes?: MediaType[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getQueryFilters: ((userId?: string, parentId?: string, includeItemTypes?: BaseItemKind[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets query filters.

      Throws

        • (userId?, parentId?, includeItemTypes?, isAiring?, isMovie?, isSports?, isKids?, isNews?, isSeries?, recursive?, options?): Promise<RequestArgs>

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

    • getQueryFiltersLegacy: ((userId?: string, parentId?: string, includeItemTypes?: BaseItemKind[], mediaTypes?: MediaType[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets legacy query filters.

      Throws

        • (userId?, parentId?, includeItemTypes?, mediaTypes?, options?): Promise<RequestArgs>

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

Settings

Member Visibility