Class SessionApi

SessionApi - object-oriented interface

Export

SessionApi

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:52

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1576

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1588

getAuthProviders

getAuthProviders(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<NameIdPair[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any, {}>>
Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1599

getPasswordResetProviders

getPasswordResetProviders(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<NameIdPair[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<NameIdPair[], any, {}>>
Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1610

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1622

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1634

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1646

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1658

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1670

reportSessionEnded

reportSessionEnded(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1681

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1693

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1705

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1717

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1729

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1741

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
Memberof
SessionApi
- Defined in generated-client/api/session-api.ts:1753

Class SessionApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SessionApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

addUserToSession

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

displayContent

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

getAuthProviders

Parameters

Returns Promise<AxiosResponse<NameIdPair[], any, {}>>

Throws

Memberof

getPasswordResetProviders

Parameters

Returns Promise<AxiosResponse<NameIdPair[], any, {}>>

Throws

Memberof

getSessions

Parameters

Returns Promise<AxiosResponse<SessionInfoDto[], any, {}>>

Throws

Memberof

play

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

postCapabilities

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

postFullCapabilities

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

removeUserFromSession

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

reportSessionEnded

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

reportViewing

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

sendFullGeneralCommand

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

sendGeneralCommand

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration