Function SessionApiFactory

Returns {
    addUserToSession(
        requestParameters: SessionApiAddUserToSessionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    displayContent(
        requestParameters: SessionApiDisplayContentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getAuthProviders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<NameIdPair[]>;
    getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<NameIdPair[]>;
    getSessions(
        requestParameters?: SessionApiGetSessionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SessionInfoDto[]>;
    play(
        requestParameters: SessionApiPlayRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    postCapabilities(
        requestParameters?: SessionApiPostCapabilitiesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    postFullCapabilities(
        requestParameters: SessionApiPostFullCapabilitiesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    removeUserFromSession(
        requestParameters: SessionApiRemoveUserFromSessionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    reportSessionEnded(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    reportViewing(
        requestParameters: SessionApiReportViewingRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    sendFullGeneralCommand(
        requestParameters: SessionApiSendFullGeneralCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    sendGeneralCommand(
        requestParameters: SessionApiSendGeneralCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    sendMessageCommand(
        requestParameters: SessionApiSendMessageCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    sendPlaystateCommand(
        requestParameters: SessionApiSendPlaystateCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    sendSystemCommand(
        requestParameters: SessionApiSendSystemCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• addUserToSession:function

  • addUserToSession(
        requestParameters: SessionApiAddUserToSessionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiAddUserToSessionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• displayContent:function

  • displayContent(
        requestParameters: SessionApiDisplayContentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiDisplayContentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getAuthProviders:function

  • getAuthProviders(options?: RawAxiosRequestConfig): AxiosPromise<NameIdPair[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<NameIdPair[]>

    Throws

• getPasswordResetProviders:function

  • getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<NameIdPair[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<NameIdPair[]>

    Throws

• getSessions:function

  • getSessions(
        requestParameters?: SessionApiGetSessionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SessionInfoDto[]>

  • Parameters

    • requestParameters: SessionApiGetSessionsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SessionInfoDto[]>

    Throws

• play:function

  • play(
        requestParameters: SessionApiPlayRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiPlayRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• postCapabilities:function

  • postCapabilities(
        requestParameters?: SessionApiPostCapabilitiesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiPostCapabilitiesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• postFullCapabilities:function

  • postFullCapabilities(
        requestParameters: SessionApiPostFullCapabilitiesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiPostFullCapabilitiesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• removeUserFromSession:function

  • removeUserFromSession(
        requestParameters: SessionApiRemoveUserFromSessionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiRemoveUserFromSessionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• reportSessionEnded:function

  • reportSessionEnded(options?: RawAxiosRequestConfig): AxiosPromise<void>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• reportViewing:function

  • reportViewing(
        requestParameters: SessionApiReportViewingRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiReportViewingRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• sendFullGeneralCommand:function

  • sendFullGeneralCommand(
        requestParameters: SessionApiSendFullGeneralCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiSendFullGeneralCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• sendGeneralCommand:function

  • sendGeneralCommand(
        requestParameters: SessionApiSendGeneralCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiSendGeneralCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• sendMessageCommand:function

  • sendMessageCommand(
        requestParameters: SessionApiSendMessageCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiSendMessageCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• sendPlaystateCommand:function

  • sendPlaystateCommand(
        requestParameters: SessionApiSendPlaystateCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiSendPlaystateCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• sendSystemCommand:function

  • sendSystemCommand(
        requestParameters: SessionApiSendSystemCommandRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiSendSystemCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws