Class PlaystateApi

PlaystateApi - object-oriented interface

Export

PlaystateApi

Hierarchy

BaseAPI
- PlaystateApi

Index

Constructors

constructor

new PlaystateApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: PlaystateApiMarkPlayedItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserItemDataDto, any>>
Parameters
- requestParameters: PlaystateApiMarkPlayedItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1090

markUnplayedItem

markUnplayedItem(
requestParameters: PlaystateApiMarkUnplayedItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserItemDataDto, any>>
Parameters
- requestParameters: PlaystateApiMarkUnplayedItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1102

onPlaybackProgress

onPlaybackProgress(
requestParameters: PlaystateApiOnPlaybackProgressRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiOnPlaybackProgressRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1114

onPlaybackStart

onPlaybackStart(
requestParameters: PlaystateApiOnPlaybackStartRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiOnPlaybackStartRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1126

onPlaybackStopped

onPlaybackStopped(
requestParameters: PlaystateApiOnPlaybackStoppedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiOnPlaybackStoppedRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1138

pingPlaybackSession

pingPlaybackSession(
requestParameters: PlaystateApiPingPlaybackSessionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiPingPlaybackSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1150

reportPlaybackProgress

reportPlaybackProgress(
requestParameters?: PlaystateApiReportPlaybackProgressRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiReportPlaybackProgressRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1162

reportPlaybackStart

reportPlaybackStart(
requestParameters?: PlaystateApiReportPlaybackStartRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiReportPlaybackStartRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1174

reportPlaybackStopped

reportPlaybackStopped(
requestParameters?: PlaystateApiReportPlaybackStoppedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PlaystateApiReportPlaybackStoppedRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
PlaystateApi
- Defined in generated-client/api/playstate-api.ts:1186

Class PlaystateApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlaystateApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

markPlayedItem

Parameters

Returns Promise<AxiosResponse<UserItemDataDto, any>>

Throws

Memberof

markUnplayedItem

Parameters

Returns Promise<AxiosResponse<UserItemDataDto, any>>

Throws

Memberof

onPlaybackProgress

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

onPlaybackStart

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

onPlaybackStopped

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

pingPlaybackSession

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

reportPlaybackProgress

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

reportPlaybackStart

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

reportPlaybackStopped

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration