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, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: SessionApiAddUserToSessionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Adds an additional user to a session.

    Throws

• displayContent:function

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

  • Parameters

    • requestParameters: SessionApiDisplayContentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Instructs a session to browse to an item or view.

    Throws

• getAuthProviders:function

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

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<NameIdPair[]>

    Summary

    Get all auth providers.

    Throws

• getPasswordResetProviders:function

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

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<NameIdPair[]>

    Summary

    Get all password reset providers.

    Throws

• getSessions:function

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

  • Parameters

    • requestParameters: SessionApiGetSessionsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SessionInfoDto[]>

    Summary

    Gets a list of sessions.

    Throws

• play:function

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

  • Parameters

    • requestParameters: SessionApiPlayRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Instructs a session to play an item.

    Throws

• postCapabilities:function

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

  • Parameters

    • requestParameters: SessionApiPostCapabilitiesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates capabilities for a device.

    Throws

• postFullCapabilities:function

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

  • Parameters

    • requestParameters: SessionApiPostFullCapabilitiesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates capabilities for a device.

    Throws

• removeUserFromSession:function

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

  • Parameters

    • requestParameters: SessionApiRemoveUserFromSessionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Removes an additional user from a session.

    Throws

• reportSessionEnded:function

  • reportSessionEnded(options?): AxiosPromise<void>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that a session has ended.

    Throws

• reportViewing:function

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

  • Parameters

    • requestParameters: SessionApiReportViewingRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that a session is viewing an item.

    Throws

• sendFullGeneralCommand:function

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

  • Parameters

    • requestParameters: SessionApiSendFullGeneralCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Issues a full general command to a client.

    Throws

• sendGeneralCommand:function

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

  • Parameters

    • requestParameters: SessionApiSendGeneralCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Issues a general command to a client.

    Throws

• sendMessageCommand:function

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

  • Parameters

    • requestParameters: SessionApiSendMessageCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Issues a command to a client to display a message to the user.

    Throws

• sendPlaystateCommand:function

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

  • Parameters

    • requestParameters: SessionApiSendPlaystateCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Issues a playstate command to a client.

    Throws

• sendSystemCommand:function

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

  • Parameters

    • requestParameters: SessionApiSendSystemCommandRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Issues a system command to a client.

    Throws