Class PlaylistsApi

PlaylistsApi - object-oriented interface

Export

PlaylistsApi

Hierarchy

BaseAPI
- PlaylistsApi

Index

Constructors

constructor

Methods

addItemToPlaylist createPlaylist getPlaylist getPlaylistItems getPlaylistUser getPlaylistUsers moveItem removeItemFromPlaylist removeUserFromPlaylist updatePlaylist updatePlaylistUser

Constructors

constructor

new PlaylistsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): PlaylistsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PlaylistsApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

addItemToPlaylist

addItemToPlaylist(
requestParameters: PlaylistsApiAddItemToPlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaylistsApiAddItemToPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1186

createPlaylist

createPlaylist(
requestParameters?: PlaylistsApiCreatePlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlaylistCreationResult, any>>
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 Promise<AxiosResponse<PlaylistCreationResult, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1198

getPlaylist

getPlaylist(
requestParameters: PlaylistsApiGetPlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlaylistDto, any>>
Parameters
- requestParameters: PlaylistsApiGetPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlaylistDto, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1210

getPlaylistItems

getPlaylistItems(
requestParameters: PlaylistsApiGetPlaylistItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: PlaylistsApiGetPlaylistItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1222

getPlaylistUser

getPlaylistUser(
requestParameters: PlaylistsApiGetPlaylistUserRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlaylistUserPermissions, any>>
Parameters
- requestParameters: PlaylistsApiGetPlaylistUserRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlaylistUserPermissions, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1234

getPlaylistUsers

getPlaylistUsers(
requestParameters: PlaylistsApiGetPlaylistUsersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlaylistUserPermissions[], any>>
Parameters
- requestParameters: PlaylistsApiGetPlaylistUsersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlaylistUserPermissions[], any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1246

moveItem

moveItem(
requestParameters: PlaylistsApiMoveItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaylistsApiMoveItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1258

removeItemFromPlaylist

removeItemFromPlaylist(
requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1270

removeUserFromPlaylist

removeUserFromPlaylist(
requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1282

updatePlaylist

updatePlaylist(
requestParameters: PlaylistsApiUpdatePlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaylistsApiUpdatePlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1294

updatePlaylistUser

updatePlaylistUser(
requestParameters: PlaylistsApiUpdatePlaylistUserRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaylistsApiUpdatePlaylistUserRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaylistsApi
- Defined in generated-client/api/playlists-api.ts:1306

Class PlaylistsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlaylistsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

addItemToPlaylist

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

createPlaylist

Parameters

Returns Promise<AxiosResponse<PlaylistCreationResult, any>>

Throws

Memberof

getPlaylist

Parameters

Returns Promise<AxiosResponse<PlaylistDto, any>>

Throws

Memberof

getPlaylistItems

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Throws

Memberof

getPlaylistUser

Parameters

Returns Promise<AxiosResponse<PlaylistUserPermissions, any>>

Throws

Memberof

getPlaylistUsers

Parameters

Returns Promise<AxiosResponse<PlaylistUserPermissions[], any>>

Throws

Memberof

moveItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

removeItemFromPlaylist

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

removeUserFromPlaylist

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

updatePlaylist

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

updatePlaylistUser

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration