Function PlaylistsApiFactory

Returns {
    addItemToPlaylist(requestParameters: PlaylistsApiAddItemToPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    createPlaylist(requestParameters?: PlaylistsApiCreatePlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistCreationResult>;
    getPlaylist(requestParameters: PlaylistsApiGetPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistDto>;
    getPlaylistItems(requestParameters: PlaylistsApiGetPlaylistItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
    getPlaylistUser(requestParameters: PlaylistsApiGetPlaylistUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistUserPermissions>;
    getPlaylistUsers(requestParameters: PlaylistsApiGetPlaylistUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaylistUserPermissions[]>;
    moveItem(requestParameters: PlaylistsApiMoveItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    removeItemFromPlaylist(requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    removeUserFromPlaylist(requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    updatePlaylist(requestParameters: PlaylistsApiUpdatePlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    updatePlaylistUser(requestParameters: PlaylistsApiUpdatePlaylistUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• addItemToPlaylist:function

  • addItemToPlaylist(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiAddItemToPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Adds items to a playlist.

    Throws

• createPlaylist:function

  • createPlaylist(requestParameters?, options?): AxiosPromise<PlaylistCreationResult>

  • For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

    Parameters

    • requestParameters: PlaylistsApiCreatePlaylistRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistCreationResult>

    Summary

    Creates a new playlist.

    Throws

• getPlaylist:function

  • getPlaylist(requestParameters, options?): AxiosPromise<PlaylistDto>

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistDto>

    Summary

    Get a playlist.

    Throws

• getPlaylistItems:function

  • getPlaylistItems(requestParameters, options?): AxiosPromise<BaseItemDtoQueryResult>

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistItemsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Summary

    Gets the original items of a playlist.

    Throws

• getPlaylistUser:function

  • getPlaylistUser(requestParameters, options?): AxiosPromise<PlaylistUserPermissions>

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistUserRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistUserPermissions>

    Summary

    Get a playlist user.

    Throws

• getPlaylistUsers:function

  • getPlaylistUsers(requestParameters, options?): AxiosPromise<PlaylistUserPermissions[]>

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistUsersRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistUserPermissions[]>

    Summary

    Get a playlist's users.

    Throws

• moveItem:function

  • moveItem(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiMoveItemRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Moves a playlist item.

    Throws

• removeItemFromPlaylist:function

  • removeItemFromPlaylist(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Removes items from a playlist.

    Throws

• removeUserFromPlaylist:function

  • removeUserFromPlaylist(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Remove a user from a playlist's users.

    Throws

• updatePlaylist:function

  • updatePlaylist(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiUpdatePlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates a playlist.

    Throws

• updatePlaylistUser:function

  • updatePlaylistUser(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiUpdatePlaylistUserRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Modify a user of a playlist's users.

    Throws