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

    Summary

    Deletes a user's saved personal rating for an item.

    Throws

• getIntros:function

  • getIntros(itemId, userId?, options?): 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>)>

    Summary

    Gets intros to play before the main media item plays.

    Throws

• getItem:function

  • getItem(itemId, userId?, options?): 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>)>

    Summary

    Gets an item from a user's library.

    Throws

• getLatestMedia:function

  • getLatestMedia(userId?, parentId?, fields?, includeItemTypes?, isPlayed?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, limit?, groupItems?, options?): 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[]>)>

    Summary

    Gets latest media.

    Throws

• getLocalTrailers:function

  • getLocalTrailers(itemId, userId?, options?): 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[]>)>

    Summary

    Gets local trailers for an item.

    Throws

• getRootFolder:function

  • getRootFolder(userId?, options?): 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>)>

    Summary

    Gets the root folder from a user's library.

    Throws

• getSpecialFeatures:function

  • getSpecialFeatures(itemId, userId?, options?): 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[]>)>

    Summary

    Gets special features for an item.

    Throws

• markFavoriteItem:function

  • markFavoriteItem(itemId, userId?, options?): 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>)>

    Summary

    Marks an item as a favorite.

    Throws

• unmarkFavoriteItem:function

  • unmarkFavoriteItem(itemId, userId?, options?): 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>)>

    Summary

    Unmarks item as a favorite.

    Throws

• updateUserItemRating:function

  • updateUserItemRating(itemId, userId?, likes?, options?): 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>)>

    Summary

    Updates a user's rating for an item.

    Throws