neko/webpage/docs/api/keyboard-modifiers-set.api.mdx
2025-03-22 17:52:56 +01:00

71 lines
No EOL
4.6 KiB
Text

---
id: keyboard-modifiers-set
title: "Set Keyboard Modifiers"
description: "Update the keyboard modifiers status."
sidebar_label: "Set Keyboard Modifiers"
hide_title: true
hide_table_of_contents: true
api: eJzVWFtv3LYS/isDBijOEbRaN+nTvrnuFjUSJ4XXOX1wjINZaVZiliIVDmVna+x/L4aUduVLisDoS/2ykjiXb4YzH4e+VwFrVotr5Z1rZ1varR36St3kqiIuve6CdlYt1MeuwkAQGoJRCFpX6Y0mz8ABQ8+FypXryKPonFdqoUbRi1FyRUHlyhN3zjKxWtyr1yc/yc9Dd2+f+ugjggq4L0ti3vTG7Aq1z9VPJz8+NXDVEHj60hOH+Ks9MfRMHrAPDdmgywhTMJfOBrJBjGDXmWFl/pnF0r3isqEW5SnsOlIL5dafqZQ4Oi/hBp0CaYkZa5oIcvDa1upxLn+hgNpQBeS98zDoFWq/z1XQwYjqUpYuBov7/T7G+eb5OJn8LXnobUWeg3NV3KYh+hzWvaRg0zMxBBfjd17/SaDDvyb6vRRNjOdnV+3EyT8Emxu9CROxtXOG0D5BfW4rcUEMehPTGxWlF0AzdJ6YqYrlWGLHxpXblxgVXRDl0TCWQd9Ssuts8M68yGxSfQ4tmhdFj+bZ2G3fvjR027ffirylgC8xKXrPoeS+I/+iPRfFb2SxfpHFqPjU4qQV3j6mUHXoBu2pUovge0pJapxwbuc4ljmGRi3UHDs9F26fj1w8P1CqylWiDjkAHhPLO1eiGahF5ar3Ri1UE0K3mM+NrDWOw+LNycmJ2t+IobL3OuyipZ8JPfnTXhBc3+zze3Xm3FbT9MuV25I9fJhYWEnnpuacah1yi51+SzuVKy0wyyiicmWxldX3y7cf/r9arlbnH94/Sf/pA+qHnrWtAYGJWd6Trbih0wgOniV6yVkEKLschb7XSzIJQeKOPiYZ+EZwX3ryu2NsUfV73UVh6FAqCpABIVqDDj22FMinMhO+vDwy6/Irtp2hCTNKeU1JbXgfySi9RhZJjwcKSK+pd9Pz0HcHldofqlfbjYtpGKr+PW0dnP5+rnIl9ZkifVOcFCdP4o+i8XD7g9aXV2eAtpLHlSu3FGBNrCtiuFyursSiHIGdd7e6kiMSzSzolkBeHXDwhK22dQ7aBvKJg6B0xuDapbkmj/Y9tS4QVMTb4DrY9LaURTQ67IpP9pN99eoVnDlPcEVlY51xtSaWhRlk2f+it9XoDZwc3wl9ln2yADOIURm6JY81MWTZuAwb54/AczDubmYwkC13OTS6bmZf+ghjiEnQYl/pSXRFcnGYsUSkdT0T0C3ZwICeIHi03OogI1fEFwkQWxrTXDprKUYdITFha4j5mDlnizHgS8F7JYle6VqyJCVqKzhzbdvbsXTHNKSdGzMRQx8/CU32UtHR5dGYtiOs/1BRF/mhp4kDro3mpiUbcjg/W0KJttJxmqWvZYO2pv8WAMnZu7jfDYajhTR3ctr3CYlKvjZozBrLbcxYg7YyY7YOmI85GAtQoC9vye9CI9CXhukY66Nu/gFWA4wLtFiTRJFlMIOVsCU9N9FGnCP4iEm2fAwwyy6da6PMR9F9ZPbME4bYAPGU2MVHER4aPiY7OY1TuHSTnC48cfDL0BRnSYWj4dPqc89iGbj0REK2dqPrPjUV59AKEFnffqssi9HBaseBWviN0IQGfoALCl6Xyc+lPNNtdJTEmiRWNlRuORo93FHQgLas6yYk/Kltf3N3cB7g1Bj4w/ktw5WrKTTkReDHYtqLacsZWqo0HhssbnGWPaKXfOhDgVBhwCwrPtnXxaMCJ8u93FUQsqwT6uMQK3etK+1pYJkse9x+ExqYdmCK600xqb8sG/lPaGWjLc1qj9rSYZOzLNXwZJ8H1pPSebBxsbp/lTFeuK6Koz3nct2IR10kDbmpxcKvXNlLpY2aKldGl2Q5njfDIXfaYdkQvI5M/2DquLu7KzCuFs7X80GV5+/Oz5bvV8vZ6+KkaEJr4rkmU1CLdmJ4ReFIeReTGejBcTK5WHz3nXc4uwN9DfPOoLZyukfo98MYdi0Hu1x8nWtVfrgWq1wdh7GbXMlIJcL392tk+ujNfi+f0xiwuL7J1S16jWs5ImWKUg1hJUfq9b3YVAt1lsDPrgSSiJs+jRWPbkgygSWN07KkLvyt7M1kuvz9w+pK5Wo93MJaV4mOxzuJDu/UQsV/AsTaE4H47V4ZtHUfr4cq2ZS/vwC8Jrvz
sidebar_class_name: "post api-method"
info_path: docs/v3/api
custom_edit_url: null
---
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>