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

71 lines
No EOL
4.3 KiB
Text

---
id: clipboard-set-text
title: "Set Clipboard Content"
description: "Update the content of the clipboard (rich-text or plain-text)."
sidebar_label: "Set Clipboard Content"
hide_title: true
hide_table_of_contents: true
api: eJzVV9+P0zgQ/ldGRkIQpWnZ5V4qhLSUnlgBC9qW4wFWJzeZJqaOHWxnl96q//tpxkkbugtCunuhL03i8cz3jeeXb0WQpRfTT8JZW49yrZqVla4QV6ko0OdONUFZI6biQ1PIgBAqhNyagCaAXcfXfhM8ciqvRgG/BbAOGi2V4bfHmUiFbdBJUnZeiKnYb1pgWOK3IFLh0DfWePRieitOJk/p73sMs72lHkLLqArwbZ6j9+tW620mdql4Onlyd/+yQnD4tUUf+F859NB6dCDbUKEJKmeEBLezQEpk0+huZfzFk6Zb4fMKa0lPYdugmAq7+oI50WgcMQ0q8qjRe1niQNAHp0wpjv37EoNUGgtA56yDbl8mdrtUBBU0bZ3T0ttO4263Y56n9/P06K7RQWsKdD5YW/BZdexTWLXkgnXr0UOwzN869Q+CCr8R+z8mk7vsPxi50kisPIZBdHacfht6O0oJPq4XttiSkf8JNqXkfZjxm6wbxjKzjcICZl2WPTk5vUOJYowzHDjff1QTOBmrUOufG3y2en7X5rPx6vm9dl8t3775mcWBV/clg4vM3qnKYSGmwbW4S0WNobJUlBrr2VsyVGIqxrJRYyqL40NZTEXMKyqZx3H3xuZSd3knUtE6LaaiCqGZjsea1irrw/R0MpmI3RUpylunwpY1vUDp0J21ZPjT1S69FTNrNwqHX5Z2g2b/YaBhQecej3a4a+9v2ajXuBWpUAQzZxGRCiNrWr2Yv37392K+WJy/u7jj7bPv6iK0XpkSJHj0nt6jLj7jIYO9ZWJPPmOAYipWLPSrVqJKCMSbbQw88ANyX1t02wM33vqr5lgYGuk9FiA9SGBt0EgnawzoYmRRtl0e8nLex3CfV/cnT0yBn8T5jhisLevpYvcCNxbO3p+LVFDIRfCn2SSb3KHEolzMP+LqcjkDaQp6XNh8gwFW6FWBHi7niyVppOLYOHutCmoJUo+CqhHo1YIPDmWtTJmCMgGdzIO6pqavtVzZ2MJT1u+wtgGhQL8JtoF1a3JalFqFbfbZfDYPHjyAmXUIS8wrY7UtFXpaGEGS/MXWFr01sNSuIvok+WwARsCsNF6jkyV6SJJ+GdbWHYCnoO3NSMuAJt+mUKmyGn1tGUbHidDKtlADdlk08Rq3sTuQSG1bj4DXaIIH6RCCk8bXKtCIwfio0nhZY+/m3BqDzJoheZS1Ru8PnrMm6wlfEt4lOXqhSvISRZ2hSKjr1vTR2LshnlzvCabefwLFU0sRTR6UKdPDeoRZmaX7NEUf5EorX9VoQgrnsznk0hSKJzr8llfSlPg4A4jG3vB5VzIcNMQ5y8dz33Q+G0d/raXWK5lv2GOVNIXuvbXHfPBBH4AEfX6Nbhsqgj7XHg9cjxL0ISw6GG+lkSUSiySBESyoAOJ9Exzj7MEzJjrynmCSXFpbs8wH2nukduZQBk6A2hZqveVHEqaW46xmZ0ejPHVSNlGf8AMDL7ukmMUtnhWfFV9aT5rB5w6R6qdZq7KNSeVTqAkIrW9+FJZZb2Cx9QFreIVShwoewlsMTuXRziU94zUbimJVFMsrzDeele7HcalBGa/KKkT8MW1f2Rs4D3CmNXy0buNhaUsMFToSeJINczEeuYcaCyUPCcZHnCRH5SXt8pAgFDLIJMk+m5PsKMDR+JZmcwlJ0lDp84Ejd6UK5bCrMklynH6DMjDMwMjrNBvEX5L09Y/KyloZHJVOKoP7Q06SGMODc+6qHoXOdwfH0f0nzXVU6wqe9XxK4zV3Ly4adDPhwC9s3lKk9TtFKrTK0XhuIV3fOmtkXiGccKX/bpC4ubnJJK9m1pXjbqsfvzmfzS8W89FJNsm411CronmmlmageIEBDreorgcdd5PBoPnfr31dm6b3MS9Rp2NKt92g9Yl6ON3/rK1pNh/eQWlkIonb25X0+MHp3Y4+xzY//XSVimvpFM37cUoSFcoCHc9UG9xyN2bUoyXhIHHdxrHhaH6mCSvuOMtzbMJPZa8GQ+P7d4ulSMWqm9FrW9AeJ2+IkrwRU8GXXw5EEuBvt0JLU7Z8eRBRJ/3+BWwGYvU=
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 Clipboard Content"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/room/clipboard"}
context={"endpoint"}
>
</MethodEndpoint>
Update the content of the clipboard (rich-text or plain-text).
<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":{"text":{"type":"string","example":"Copied Content 123","description":"The plain text content of the clipboard."},"html":{"type":"string","example":"<b>Copied Content 123</b>","description":"The HTML content of the clipboard."}},"title":"ClipboardText"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"Clipboard content 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"}}}},"500":{"description":"Unable to set clipboard content.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>