Class SessionApi

SessionApi - object-oriented interface

Hierarchy

BaseAPI
- SessionApi

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

addUserToSession

addUserToSession(
requestParameters: SessionApiAddUserToSessionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiAddUserToSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1636

displayContent

displayContent(
requestParameters: SessionApiDisplayContentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiDisplayContentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1647

getSessions

getSessions(
requestParameters?: SessionApiGetSessionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SessionInfoDto[], any, {}>>
Parameters
- requestParameters: SessionApiGetSessionsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SessionInfoDto[], any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1658

pingPlaybackSession

pingPlaybackSession(
requestParameters: SessionApiPingPlaybackSessionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiPingPlaybackSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1669

play

play(
requestParameters: SessionApiPlayRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiPlayRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1680

postCapabilities

postCapabilities(
requestParameters?: SessionApiPostCapabilitiesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiPostCapabilitiesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1691

postFullCapabilities

postFullCapabilities(
requestParameters: SessionApiPostFullCapabilitiesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiPostFullCapabilitiesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1702

removeUserFromSession

removeUserFromSession(
requestParameters: SessionApiRemoveUserFromSessionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiRemoveUserFromSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1713

reportPlaybackProgress

reportPlaybackProgress(
requestParameters?: SessionApiReportPlaybackProgressRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiReportPlaybackProgressRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1724

reportPlaybackStart

reportPlaybackStart(
requestParameters?: SessionApiReportPlaybackStartRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiReportPlaybackStartRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1735

reportPlaybackStopped

reportPlaybackStopped(
requestParameters?: SessionApiReportPlaybackStoppedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiReportPlaybackStoppedRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1746

reportSessionEnded

reportSessionEnded(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1756

reportViewing

reportViewing(
requestParameters: SessionApiReportViewingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiReportViewingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1767

sendFullGeneralCommand

sendFullGeneralCommand(
requestParameters: SessionApiSendFullGeneralCommandRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiSendFullGeneralCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1778

sendGeneralCommand

sendGeneralCommand(
requestParameters: SessionApiSendGeneralCommandRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiSendGeneralCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1789

sendMessageCommand

sendMessageCommand(
requestParameters: SessionApiSendMessageCommandRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiSendMessageCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1800

sendPlaystateCommand

sendPlaystateCommand(
requestParameters: SessionApiSendPlaystateCommandRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiSendPlaystateCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1811

sendSystemCommand

sendSystemCommand(
requestParameters: SessionApiSendSystemCommandRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SessionApiSendSystemCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/session-api.ts:1822