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

63 lines
No EOL
4.1 KiB
Text

---
id: clipboard-get-text
title: "Get Clipboard Content"
description: "Retrieve the current content of the clipboard (rich-text or plain-text)."
sidebar_label: "Get Clipboard Content"
hide_title: true
hide_table_of_contents: true
api: eJzVV01v2zgQ/SsDFii6giy7ye7FKApkXW8btEkXsbs9JMGCpsYSa4pUScqJ1/B/Xwwp2YqTFj300pMkcjjz5nG+tGWeF46Nr5k1phoIJeuF4TZntynL0Qkray+NZmN2hd5KXCP4EkE01qL2IIz29DTLuNwdhxdWinLg8d6DsVArLnX4+i1jKTM1Wk5qz3M2ZvtDb9HP8d6zlFl0tdEOHRtv2cloRI+HaCZ7Sx0E2+LLwTVCoHPLRqkNmWslSAmvayVFsD384kjTljlRYsXpzW9qZGNmFl9QEIzaElIvIw6C35Ny3kpdsJThPa9qRUsTU0vMYdIienlyyo5ZnJcY2YDAzbf4y9guZaWv1PcNvlq8fmzz1XDx+km77+YXH75ncZcyL330pFsOF7Lb0d7vo5eP74H0WvzaoPPhKS06aBxa4I0vUfuW7Z94DxU6xwt8ipmH2N6g51JhDmitsdCee+jolLYuWo2dn6dP++nQrtFCo3O0zhuTBwZb71NYNETBsnHowJvgv7HyPwTpfyHv/3gq2z5pvlBIXhXoe1ne+vTLuLdLWYW+NFR2CgzWuS/ZmA15LYdUAYeHCpiyeOFUHY8J+WAEV21AsJQ1VrExK72vx8Ohor3SOD8+HY1GbHdLikRjpd8ETX8it2jPGjJ8fbtLt2xizEpif2VuVqj3Cz0NM+IxUtU/tWeL1/I9bljKJMEUQYSlTPOKdi+n7z/+O5vOZucfLx8xevYgYaFxUhfAwaFz9B11hcLU92BvmbwnzgJANmaLIPSjVqJK8OR3sNFj4BvOfW3Qbg6+haM/ai4IQ82dwxy4Aw5BG9Tc8go92hhIUi9NsN8G1CWuDJz9fc5SRoERTZxmo2z0yHAQDbXgMy6u5hPgOqfXmREr9LBAJ3N0cDWdzUkj5VZtzVrmVFG4GnhZIdCnAect8krqIgWpPVouvFwjCKMUX5jYSdOg32JlPEKObuVNDctGC9rkSvpNdqNv9LNnz2BiLMIcRamNMoVERxsDSJJ/grVZZw0MVbuIPkluNMAAglcK12h5gQ6SpNuGpbEH4CkoczdQ3KMWmxRKWZSDr02A0fpEaHmTy553WTTxHjexuJBIZRqHgGvU3gG3CN5y7SrpPeYRH5VgxyvsaBZGawxeB0gOeaXQuQNzRmedw1eEd05Ez2RBLFFsaGqmVdXoLmY6GuLNdUwE17slkKHp5dHkQZnUHawXmBVZuk8mdJ4vlHRlhdqncD6ZguA6lzn3CHgvSq4L/C0DiMY+hPsuuT9oaGqSdfHeVy1nw8jXkiu14GIVGCu5zlXH1h7zgYMuAAn6dI1240uCPlUOD74epdFzmLUwLrjmBZIXSQIDmFGZwqcGgICzAx8w0ZV3DibJlTFVkPlEZ4/UTixyHxKgMrlcbsIrCVPXsUYFsqPRMPpRNlE1dz0Db9qkmMQjLig+y780jjSDExaRqpxeyqKJSeVSqAgI7a++FZZZZ2C2cR4reIdc+RKewwUNpCLaaYfnYCiKlVFMlChWLijdT8VcgdROFqWP+GPavjN3cO7hTCn4bOzKwdwU6Eu0JPAy6+divHIHFeaSHxIsXHGSHJWXtM1DgpBzz5Mku9En2VGAo3YNjXYckqSm0ud8iNyFzKXFtsokyXH69cpAPwOjX6dZL/6SpKt/VFaWUuOgsFxq3F9yksQY7t1zW/UodB5cXIjuv2gsoFqXh1HBpTSdhR4Tigb9HoTAz41oKNK6kyxlSgrULkwhbXc5q7koEU5CpX/Q7u/u7jIedjNji2F71A0/nE+ml7Pp4CQbZWGSp4ZSG+crrnuK36KHw89MO8Yfd5PtYbz6mf9hbVul72HYosYbnNu2g9E19Vz6ITOmoiGv/3tIIw5JbLcL7vCTVbsdLce2PL6+TdmaW0mDY5xqWIk8RxtmoBVuiFQhsCZn11w1scEfTY40+uwntrfTOdvt/gcwFRl2
sidebar_class_name: "get 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={"Get Clipboard Content"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/room/clipboard"}
context={"endpoint"}
>
</MethodEndpoint>
Retrieve the current content of the clipboard (rich-text or plain-text).
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Clipboard content retrieved successfully.","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"}}}},"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 get clipboard content.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>