Function UserViewsApiFp

UserViewsApi - functional programming interface

Export

  • UserViewsApiFp(
        configuration?: Configuration,
    ): {
        getGroupingOptions(
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SpecialViewOptionDto[]>,
        >;
        getUserViews(
            userId?: string,
            includeExternalContent?: boolean,
            presetViews?: CollectionType[],
            includeHidden?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
    }

  • Parameters

    Returns {
        getGroupingOptions(
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SpecialViewOptionDto[]>,
        >;
        getUserViews(
            userId?: string,
            includeExternalContent?: boolean,
            presetViews?: CollectionType[],
            includeHidden?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
    }

    • getGroupingOptions:function
      • getGroupingOptions(
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SpecialViewOptionDto[]>,
        >

      • Parameters

        • OptionaluserId: string

          User id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SpecialViewOptionDto[]>,
        >

        Throws

    • getUserViews:function
      • getUserViews(
            userId?: string,
            includeExternalContent?: boolean,
            presetViews?: CollectionType[],
            includeHidden?: boolean,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >

      • Parameters

        • OptionaluserId: string

          User id.

        • OptionalincludeExternalContent: boolean

          Whether or not to include external views such as channels or live tv.

        • OptionalpresetViews: CollectionType[]

          Preset views.

        • OptionalincludeHidden: boolean

          Whether or not to include hidden content.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility