Function UserViewsApiFp

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?, options?): 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[]>)>

    Summary

    Get user view grouping options.

    Throws

• getUserViews:function

  • getUserViews(userId?, includeExternalContent?, presetViews?, includeHidden?, options?): 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>)>

    Summary

    Get user views.

    Throws