Class PlaystateApi

PlaystateApi - object-oriented interface

Export

PlaystateApi

Hierarchy

BaseAPI
- PlaystateApi

Index

Constructors

Properties

axios basePath configuration

Methods

markPlayedItem markUnplayedItem onPlaybackProgress onPlaybackStart onPlaybackStopped pingPlaybackSession reportPlaybackProgress reportPlaybackStart reportPlaybackStopped

Constructors

constructor

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

markPlayedItem

markPlayedItem(requestParameters, options?): Promise<AxiosResponse<UserItemDataDto, any>>
Parameters
- requestParameters: PlaystateApiMarkPlayedItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto, any>>
Summary
Marks an item as played for user.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1090

markUnplayedItem

markUnplayedItem(requestParameters, options?): Promise<AxiosResponse<UserItemDataDto, any>>
Parameters
- requestParameters: PlaystateApiMarkUnplayedItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto, any>>
Summary
Marks an item as unplayed for user.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1102

onPlaybackProgress

onPlaybackProgress(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiOnPlaybackProgressRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports a session's playback progress.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1114

onPlaybackStart

onPlaybackStart(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiOnPlaybackStartRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that a session has begun playing an item.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1126

onPlaybackStopped

onPlaybackStopped(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiOnPlaybackStoppedRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that a session has stopped playing an item.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1138

pingPlaybackSession

pingPlaybackSession(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiPingPlaybackSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Pings a playback session.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1150

reportPlaybackProgress

reportPlaybackProgress(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiReportPlaybackProgressRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports playback progress within a session.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1162

reportPlaybackStart

reportPlaybackStart(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiReportPlaybackStartRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports playback has started within a session.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1174

reportPlaybackStopped

reportPlaybackStopped(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiReportPlaybackStoppedRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports playback has stopped within a session.

Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1186