Function UserLibraryApiFp

Returns {
    deleteUserItemRating(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >;
    getIntros(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >;
    getItem(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>,
    >;
    getLatestMedia(
        userId?: string,
        parentId?: string,
        fields?: ItemFields[],
        includeItemTypes?: BaseItemKind[],
        isPlayed?: boolean,
        enableImages?: boolean,
        imageTypeLimit?: number,
        enableImageTypes?: ImageType[],
        enableUserData?: boolean,
        limit?: number,
        groupItems?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDto[]>,
    >;
    getLocalTrailers(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDto[]>,
    >;
    getRootFolder(
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>,
    >;
    getSpecialFeatures(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDto[]>,
    >;
    markFavoriteItem(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >;
    unmarkFavoriteItem(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >;
    updateUserItemRating(
        itemId: string,
        userId?: string,
        likes?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >;
}

• deleteUserItemRating: function

  • deleteUserItemRating(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getIntros: function

  • getIntros(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getItem: function

  • getItem(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getLatestMedia: function

  • getLatestMedia(
        userId?: string,
        parentId?: string,
        fields?: ItemFields[],
        includeItemTypes?: BaseItemKind[],
        isPlayed?: boolean,
        enableImages?: boolean,
        imageTypeLimit?: number,
        enableImageTypes?: ImageType[],
        enableUserData?: boolean,
        limit?: number,
        groupItems?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDto[]>,
    >

    Parameters

    • OptionaluserId: string

      User id.

    • OptionalparentId: string

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

    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.

    • OptionalincludeItemTypes: BaseItemKind[]

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

    • OptionalisPlayed: boolean

      Filter by items that are played, or not.

    • OptionalenableImages: boolean

      Optional. include image information in output.

    • OptionalimageTypeLimit: number

      Optional. the max number of images to return, per image type.

    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.

    • OptionalenableUserData: boolean

      Optional. include user data.

    • Optionallimit: number

      Return item limit.

    • OptionalgroupItems: boolean

      Whether or not to group items into a parent container.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getLocalTrailers: function

  • getLocalTrailers(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDto[]>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getRootFolder: function

  • getRootFolder(
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>,
    >

    Parameters

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getSpecialFeatures: function

  • getSpecialFeatures(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDto[]>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• markFavoriteItem: function

  • markFavoriteItem(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• unmarkFavoriteItem: function

  • unmarkFavoriteItem(
        itemId: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateUserItemRating: function

  • updateUserItemRating(
        itemId: string,
        userId?: string,
        likes?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UserItemDataDto>,
    >

    Parameters

    • itemId: string

      Item id.

    • OptionaluserId: string

      User id.

    • Optionallikes: boolean

      Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws