Class LyricsApi

LyricsApi - object-oriented interface

Export

LyricsApi

Hierarchy

BaseAPI
- LyricsApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteLyrics downloadRemoteLyrics getLyrics getRemoteLyrics searchRemoteLyrics uploadLyrics

Constructors

constructor

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

deleteLyrics

deleteLyrics(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LyricsApiDeleteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes an external lyric file.

Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:556

downloadRemoteLyrics

downloadRemoteLyrics(requestParameters, options?): Promise<AxiosResponse<LyricDto, any>>
Parameters
- requestParameters: LyricsApiDownloadRemoteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto, any>>
Summary
Downloads a remote lyric.

Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:568

getLyrics

getLyrics(requestParameters, options?): Promise<AxiosResponse<LyricDto, any>>
Parameters
- requestParameters: LyricsApiGetLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto, any>>
Summary
Gets an item's lyrics.

Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:580

getRemoteLyrics

getRemoteLyrics(requestParameters, options?): Promise<AxiosResponse<LyricDto, any>>
Parameters
- requestParameters: LyricsApiGetRemoteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto, any>>
Summary
Gets the remote lyrics.

Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:592

searchRemoteLyrics

searchRemoteLyrics(requestParameters, options?): Promise<AxiosResponse<RemoteLyricInfoDto[], any>>
Parameters
- requestParameters: LyricsApiSearchRemoteLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoteLyricInfoDto[], any>>
Summary
Search remote lyrics.

Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:604

uploadLyrics

uploadLyrics(requestParameters, options?): Promise<AxiosResponse<LyricDto, any>>
Parameters
- requestParameters: LyricsApiUploadLyricsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LyricDto, any>>
Summary
Upload an external lyric file.

Throws
Memberof
LyricsApi
- Defined in generated-client/api/lyrics-api.ts:616