File: /var/www/vhost/disk-apps/pwa.sports-crowd.com/node_modules/@capacitor/clipboard/dist/docs.json
{
"api": {
"name": "ClipboardPlugin",
"slug": "clipboardplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "write",
"signature": "(options: WriteOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "WriteOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "1.0.0"
}
],
"docs": "Write a value to the clipboard (the \"copy\" action)",
"complexTypes": [
"WriteOptions"
],
"slug": "write"
},
{
"name": "read",
"signature": "() => Promise<ReadResult>",
"parameters": [],
"returns": "Promise<ReadResult>",
"tags": [
{
"name": "since",
"text": "1.0.0"
}
],
"docs": "Read a value from the clipboard (the \"paste\" action)",
"complexTypes": [
"ReadResult"
],
"slug": "read"
}
],
"properties": []
},
"interfaces": [
{
"name": "WriteOptions",
"slug": "writeoptions",
"docs": "Represents the data to be written to the clipboard.",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "string",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text value to copy.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "image",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Image in [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format to copy.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "url",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "URL string to copy.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "label",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "User visible label to accompany the copied data (Android Only).",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "ReadResult",
"slug": "readresult",
"docs": "Represents the data read from the clipboard.",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "value",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Data read from the clipboard.",
"complexTypes": [],
"type": "string"
},
{
"name": "type",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Type of data in the clipboard.",
"complexTypes": [],
"type": "string"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}