Function UserLibraryApiAxiosParamCreator

Returns {
    deleteUserItemRating: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getIntros: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    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<RequestArgs>);
    getLocalTrailers: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getRootFolder: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getSpecialFeatures: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    markFavoriteItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    unmarkFavoriteItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateUserItemRating: ((itemId: string, userId?: string, likes?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• deleteUserItemRating: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

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

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getIntros: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets intros to play before the main media item plays.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets an item from a user's library.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

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

  Summary

  Gets latest media.

  Throws

  • • (userId?, parentId?, fields?, includeItemTypes?, isPlayed?, enableImages?, imageTypeLimit?, enableImageTypes?, enableUserData?, limit?, groupItems?, options?): Promise<RequestArgs>

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

• getLocalTrailers: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets local trailers for an item.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getRootFolder: ((userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets the root folder from a user's library.

  Throws

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

    • Parameters

      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getSpecialFeatures: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets special features for an item.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• markFavoriteItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Marks an item as a favorite.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• unmarkFavoriteItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Unmarks item as a favorite.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateUserItemRating: ((itemId: string, userId?: string, likes?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a user's rating for an item.

  Throws

  • • (itemId, userId?, likes?, options?): Promise<RequestArgs>

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