Class SessionApi

SessionApi - object-oriented interface

Export

SessionApi

Hierarchy

BaseAPI
- SessionApi

Constructors

constructor

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

addUserToSession

addUserToSession(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiAddUserToSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Adds an additional user to a session.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1576

displayContent

displayContent(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiDisplayContentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Instructs a session to browse to an item or view.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1588

getAuthProviders

getAuthProviders(options?): Promise<AxiosResponse<NameIdPair[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any>>
Summary
Get all auth providers.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1599

getPasswordResetProviders

getPasswordResetProviders(options?): Promise<AxiosResponse<NameIdPair[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any>>
Summary
Get all password reset providers.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1610

getSessions

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

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1622

play

play(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiPlayRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Instructs a session to play an item.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1634

postCapabilities

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

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1646

postFullCapabilities

postFullCapabilities(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiPostFullCapabilitiesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates capabilities for a device.

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

removeUserFromSession

removeUserFromSession(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiRemoveUserFromSessionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Removes an additional user from a session.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1670

reportSessionEnded

reportSessionEnded(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that a session has ended.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1681

reportViewing

reportViewing(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiReportViewingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that a session is viewing an item.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1693

sendFullGeneralCommand

sendFullGeneralCommand(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiSendFullGeneralCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Issues a full general command to a client.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1705

sendGeneralCommand

sendGeneralCommand(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiSendGeneralCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Issues a general command to a client.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1717

sendMessageCommand

sendMessageCommand(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiSendMessageCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Issues a command to a client to display a message to the user.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1729

sendPlaystateCommand

sendPlaystateCommand(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiSendPlaystateCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Issues a playstate command to a client.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1741

sendSystemCommand

sendSystemCommand(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SessionApiSendSystemCommandRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Issues a system command to a client.

Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1753