webpage/docs/api/keyboard-modifiers-set.api.mdx
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; import ParamsDetails from "@theme/ParamsDetails"; import RequestSchema from "@theme/RequestSchema"; import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading";
<Heading as={"h1"} className={"openapi__heading"} children={"Set Keyboard Modifiers"}
</Heading>
<MethodEndpoint method={"post"} path={"/api/room/keyboard/modifiers"} context={"endpoint"}
</MethodEndpoint>
Update the keyboard modifiers status.
<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}
</Heading>
<ParamsDetails parameters={undefined}
</ParamsDetails>
<RequestSchema title={"Body"} body={{"content":{"application/json":{"schema":{"type":"object","properties":{"shift":{"type":"boolean","description":"Indicates if the shift key is pressed."},"capslock":{"type":"boolean","description":"Indicates if the caps lock key is active."},"control":{"type":"boolean","description":"Indicates if the control key is pressed."},"alt":{"type":"boolean","description":"Indicates if the alt key is pressed."},"numlock":{"type":"boolean","description":"Indicates if the num lock key is active."},"meta":{"type":"boolean","description":"Indicates if the meta key is pressed."},"super":{"type":"boolean","description":"Indicates if the super key is pressed."},"altgr":{"type":"boolean","description":"Indicates if the altgr key is pressed."}},"title":"KeyboardModifiers"}}},"required":true}}
</RequestSchema>
<StatusCodes id={undefined} label={undefined} responses={{"204":{"description":"Keyboard modifiers updated successfully."},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
</StatusCodes>