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: PlaylistsApiAddItemToPlaylistRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaylistsApiAddItemToPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• createPlaylist:function

  • createPlaylist(
        requestParameters?: PlaylistsApiCreatePlaylistRequest,
        options?: RawAxiosRequestConfig,
    ): 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>

    Throws

• getPlaylist:function

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

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistDto>

    Throws

• getPlaylistItems:function

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

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistItemsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BaseItemDtoQueryResult>

    Throws

• getPlaylistUser:function

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

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistUserRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistUserPermissions>

    Throws

• getPlaylistUsers:function

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

  • Parameters

    • requestParameters: PlaylistsApiGetPlaylistUsersRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaylistUserPermissions[]>

    Throws

• moveItem:function

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

  • Parameters

    • requestParameters: PlaylistsApiMoveItemRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• removeItemFromPlaylist:function

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

  • Parameters

    • requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• removeUserFromPlaylist:function

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

  • Parameters

    • requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updatePlaylist:function

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

  • Parameters

    • requestParameters: PlaylistsApiUpdatePlaylistRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updatePlaylistUser:function

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

  • Parameters

    • requestParameters: PlaylistsApiUpdatePlaylistUserRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws