mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-28 18:06:20 +02:00
71 lines
No EOL
4.5 KiB
Text
71 lines
No EOL
4.5 KiB
Text
---
|
|
id: settings-set
|
|
title: "Update Room Settings"
|
|
description: "Update the settings of the room."
|
|
sidebar_label: "Update Room Settings"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVV01v2zgQ/SsDFih2BVlO0558S10vGrRNi9jdHpIgoKWxxJoiVZJy6g383xczlGzFSRftYi+bS2Ry+GbefHF4L4IsvZhcCWdtPfIYgjKlFzepKNDnTjVBWSMm4nNTyIAQKoReCOyKf9PJTKTCNugkiZ8XYiJ6qTkGkQqHvrHGoxeTe3F68or+PVRwaW19gG5ZXQG+zXP0ftVqvc3ELhWvTl48PrsgK/Bbiz7wf+XQQ+vRgWxDhSaonA0jK3NrAppAILJpdLcz/uoJ6V74vMJa0lfYNigmwi6/Yk4UGkcEg4ocavReljgQ9MEpU4pjx73BIJXGAtA566A7l4ndLhVBBU1HZ7T1oUPc7XbM8+XTPD26DTpoTYHOB2uLGIPIPoVlSy5YtR49BMv8rVN/Iajwv2G/o3xhPq9tsSUl/5HZjVMbGfC2tsXQ9qW1GqV5ZPy5KUgTelCHTAflQRnooICgODG1zddY3JKlzmr/r+F7AJAOIYIyvqqJtwq3lfVUI7+qoD8P3XnigUYudY9vZB7UBm/z1nnrfplAfx6682y/r+ydYfgaXa5Wrb51mFtjKDq/qKBHgD3CMYVGt6Uy/qk8kEWhCFTqT4OMCK7FY51ne0mIePum9DBr532r3OerclhETOYbKkt9sLGeE1GGSkzEWDZqTHEe71ttKmJJUxc+Lvj3Npe6K3mRitZpMRFVCM1kPNa0R8GcvDw5ORG7GwLKW6fClpFeo3TozlrSe3WzS+/F1Nq1wuHKwq7R7BcGCHOqqFg0w1N7x8pGvcOtoLQRE5GziEiFkTXtXszefbydz+bz848Xj4J69qAlQ+spGSV49J5+RyyO55DBXjOxJ5+xgZQ7LPSzWiIkBOLNOgYe+AG5by267YEbH/1ZdSwMjfQeC5AeJDAaNNLJGgO6mFPUxy4PHW/2XdaNxscdK+bro04Tlx83iG79UWHH9acqMu4c6mjHjWFl2Tld4l/g2sLZp3ORCsrayP9ldpKdPPIKi/JV9AWXl4spSFPQ55wYBFiiVwV6uJzNF4RIF1bj7EYVdKFJPQqqRqCfFnxwKGtlyhSUCej6ZmO1lksb546U8R3WNiAU6NfBNrBqTR7rWYVtdm2uzbNnz2BqHcIC88pYbUuFnjZGkCR/srZ5rw0sXbbR+iS5NgAjYFYaN+hkiR6SpN+GlXUHw1PQ9m6kZUCTb1OoVFmNvrVsRseJrJVtoQbssqjiHW6XVrqCRWrbegTcoAmxqwYnja9VoAGJ7eOpTNbYu7mLJ2UimeRR1hq9P3jOmqwnfEn2LsjRc1WSlyhxTQFTW9et6RO6d0OMXO8Jpt4vUTduKc9Z5QFMmd6s3zArs3Rf6eiDXGrlqxpNSOF8OoNcmkLxoInf80qaEn/PAKKy9xzvSoYDQpwSfYz7uvPZOPprJbVeynzNHqukKXTvrb3NBx/0CUimzzbotqEi02fa44HrUY0/h3lnxgdpZInEIklgBHPqofjU/Ml29sazTRTynmCS8AxMMp/p7BHs1KEMXAC1LdRqy58k3DUCdnZUyjMzVRPdNH6g4E1XFNOudzDwWfG1jSOBzx0itWCzUmUbi8qnUJMhtL/+UVpmvYL51ges4S1KHSp4Dh8wOJVHPZf0jRtWFMWqKJZXmK89g+7fEFKDMl6VVYj2x7J9a+/gPMCZ1vDFurWHhS0xVOhI4EU2rMUYcg81FkoeCoxDnCRH7SXt6pBMKGSQSZJdm9PsKMHR+JZeFhKSpKHW5wNn7lIVymHXZZLkuPwGbWBYgZHXy2yQf0nS9z9qKytlcFQ6qQzug5wkMYcHce66Xjc7HgLH2f0HDd3U6woexH1KjwO+ALlp0LuKE7+weUuZ1p8UqdAqR+P5FuquvrNG5hXCKXf6B7PI3d1dJnk3s64cd0f9+P35dHYxn41Os5OsCrXm244molqaAXD3uOT0nx/mogeXyeAR8DOP0e4qD/g9jBstlaHLnm2+72axK7rn6Wlqbc1D2OHpSzcoCdzfL6XHz07vdrQcJ4HJ1U0qNtIpGjzjICUqlAU6HrvWuBUTMY22jhZkBonrNk4WR48XGsLiibM8xyb8o+zNYKz89HG+EKlYdg+kOB8IJ++IkbwTE8Evck40EuC1e6GlKVt+uYmISX9/A+gumgw=
|
|
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={"Update Room Settings"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/api/room/settings"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Update the settings of the room.
|
|
|
|
<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":{"private_mode":{"type":"boolean","description":"Indicates if the room is in private mode."},"locked_controls":{"type":"boolean","description":"Indicates if the room controls are locked."},"implicit_hosting":{"type":"boolean","description":"Indicates if implicit hosting is enabled."},"inactive_cursors":{"type":"boolean","description":"Indicates if inactive cursors are shown."},"merciful_reconnect":{"type":"boolean","description":"Indicates if merciful reconnect is enabled."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"Settings"}}},"required":true}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"204":{"description":"Room settings 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>
|
|
|
|
|
|
|