Package nl.harm27.obswebsocket.api.requests

Class BaseResponse

java.lang.Object

nl.harm27.obswebsocket.api.requests.BaseResponse

Direct Known Subclasses:

Authenticate.Response, BroadcastCustomMessage.Response, GetAuthRequired.Response, GetCurrentScene.Response, GetFilenameFormatting.Response, GetRecordingFolder.Response, GetSceneList.Response, GetStats.Response, GetStreamingStatus.Response, GetStreamSettings.Response, GetVersion.Response, GetVideoInfo.Response, OpenProjector.Response, PauseRecording.Response, ReorderSceneItems.Response, ResumeRecording.Response, SaveReplayBuffer.Response, SaveStreamSettings.Response, SendCaptions.Response, SetCurrentScene.Response, SetFilenameFormatting.Response, SetHeartbeat.Response, SetRecordingFolder.Response, SetStreamSettings.Response, StartRecording.Response, StartReplayBuffer.Response, StartStopRecording.Response, StartStopReplayBuffer.Response, StartStopStreaming.Response, StartStreaming.Response, StopRecording.Response, StopReplayBuffer.Response, StopStreaming.Response

public abstract class BaseResponse
extends Object

Response on the requests that are sent by the client.

See Also:

Constructor Summary

Constructors

Constructor	Description
BaseResponse()

Method Summary

Modifier and Type	Method	Description
String	getError()	An error message accompanying an error status.
String	getMessageId()	The client defined identifier specified in the request.
Status	getStatus()	Response status, will be one of the following: ok, error

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseResponse

public BaseResponse()

Method Detail

getMessageId

public String getMessageId()

The client defined identifier specified in the request.

getStatus

public Status getStatus()

Response status, will be one of the following: ok, error

getError

public String getError()

An error message accompanying an error status.