Class ArtistsApi

ArtistsApi - object-oriented interface

Export

ArtistsApi

Hierarchy

BaseAPI
- ArtistsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getAlbumArtists getArtistByName getArtists

Constructors

constructor

new ArtistsApi(configuration?, basePath?, axios?): ArtistsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ArtistsApi
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

getAlbumArtists

getAlbumArtists(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: ArtistsApiGetAlbumArtistsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets all album artists from a given item, folder, or the entire library.

Throws
Memberof
ArtistsApi
- Defined in generated-client/api/artists-api.ts:1128

getArtistByName

getArtistByName(requestParameters, options?): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: ArtistsApiGetArtistByNameRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Summary
Gets an artist by name.

Throws
Memberof
ArtistsApi
- Defined in generated-client/api/artists-api.ts:1140

getArtists

getArtists(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: ArtistsApiGetArtistsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets all artists from a given item, folder, or the entire library.

Throws
Memberof
ArtistsApi
- Defined in generated-client/api/artists-api.ts:1152