Package nl.harm27.obswebsocket.api.requests

Class BaseRequest

java.lang.Object

nl.harm27.obswebsocket.api.requests.BaseRequest

Direct Known Subclasses:

Authenticate.Request, BroadcastCustomMessage.Request, DisableStudioMode.Request, EnableStudioMode.Request, GetAuthRequired.Request, GetCurrentScene.Request, GetFilenameFormatting.Request, GetPreviewScene.Request, GetRecordingFolder.Request, GetSceneList.Request, GetStats.Request, GetStreamingStatus.Request, GetStreamSettings.Request, GetStudioModeStatus.Request, GetVersion.Request, GetVideoInfo.Request, OpenProjector.Request, PauseRecording.Request, ReorderSceneItems.Request, ResumeRecording.Request, SaveReplayBuffer.Request, SaveStreamSettings.Request, SendCaptions.Request, SetCurrentScene.Request, SetFilenameFormatting.Request, SetHeartbeat.Request, SetPreviewScene.Request, SetRecordingFolder.Request, SetStreamSettings.Request, StartRecording.Request, StartReplayBuffer.Request, StartStopRecording.Request, StartStopReplayBuffer.Request, StartStopStreaming.Request, StartStreaming.Request, StopRecording.Request, StopReplayBuffer.Request, StopStreaming.Request, ToggleStudioMode.Request, TransitionToProgram.Request

public abstract class BaseRequest
extends Object

Requests are sent by the client.

See Also:

Constructor Summary

Constructors

Constructor	Description
BaseRequest(RequestType type, String messageId)

Method Summary

Modifier and Type	Method	Description
String	getMessageId()	Client defined identifier for the message, will be echoed in the response.
abstract String	getRequestName()	Says what the name is of this class.
abstract Class<?>	getResponseType()	Response type class to map the response to the correct datatype.
boolean	isAuthenticationRequired()	Says if request needs to wait for authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRequest

public BaseRequest(RequestType type,
                   String messageId)

Parameters:

type - String name of the request type.

messageId - Client defined identifier for the message, will be echoed in the response.

Method Detail

getMessageId

public String getMessageId()

Client defined identifier for the message, will be echoed in the response.

getResponseType

public abstract Class<?> getResponseType()

Response type class to map the response to the correct datatype.

isAuthenticationRequired

public boolean isAuthenticationRequired()

Says if request needs to wait for authentication.

getRequestName

public abstract String getRequestName()

Says what the name is of this class.