capacitor-plugin-filesharer/dist/docs.json

Capacitor plugin to allow file sharing on Android and iOS

{
  "api": {
    "name": "FileSharerPlugin",
    "slug": "filesharerplugin",
    "docs": "",
    "tags": [
      {
        "text": "FileSharePlugin",
        "name": "name"
      },
      {
        "text": "A Capacitor 3 plugin that allows sharing of base64 data string via native\r\nshare action cards on ios and android devices",
        "name": "description"
      },
      {
        "text": "FileShareMultiOptions\r\nFileShareContentType\r\nFileShareResult",
        "name": "interfaces"
      }
    ],
    "methods": [
      {
        "name": "share",
        "signature": "(opts: FileShareSingleOptions) => any",
        "parameters": [
          {
            "name": "opts",
            "docs": "",
            "type": "FileShareSingleOptions"
          }
        ],
        "returns": "any",
        "tags": [
          {
            "name": "param",
            "text": "opts"
          },
          {
            "name": "since",
            "text": "0.0.1"
          }
        ],
        "docs": "Open share activity card with an attached base64Data",
        "complexTypes": [
          "FileShareSingleOptions",
          "FileShareResult"
        ],
        "slug": "share"
      },
      {
        "name": "shareMultiple",
        "signature": "(opts: FileShareMultiOptions) => any",
        "parameters": [
          {
            "name": "opts",
            "docs": "",
            "type": "FileShareMultiOptions"
          }
        ],
        "returns": "any",
        "tags": [
          {
            "name": "param",
            "text": "opts"
          },
          {
            "name": "since",
            "text": "0.0.1"
          }
        ],
        "docs": "Open share activity with multiple base64Data strings",
        "complexTypes": [
          "FileShareMultiOptions",
          "FileShareResult"
        ],
        "slug": "sharemultiple"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "FileShareSingleOptions",
      "slug": "filesharesingleoptions",
      "docs": "",
      "tags": [
        {
          "name": "hidden"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "header",
          "tags": [],
          "docs": "Title of the share window popup",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "FileShareResult",
      "slug": "fileshareresult",
      "docs": "",
      "tags": [
        {
          "name": "hidden"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "result",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "message",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "FileShareMultiOptions",
      "slug": "filesharemultioptions",
      "docs": "",
      "tags": [
        {
          "name": "hidden"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "header",
          "tags": [],
          "docs": "Title of the share window popup",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "files",
          "tags": [],
          "docs": "Array of files for uploading",
          "complexTypes": [
            "FileShareOptions"
          ],
          "type": "{}"
        }
      ]
    },
    {
      "name": "FileShareOptions",
      "slug": "fileshareoptions",
      "docs": "",
      "tags": [
        {
          "name": "hidden"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "filename",
          "tags": [],
          "docs": "Filename",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "base64Data",
          "tags": [],
          "docs": "base64Data string",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "contentType",
          "tags": [],
          "docs": "Content type using FileShareContentType of string for advanced types",
          "complexTypes": [],
          "type": "string"
        }
      ]
    }
  ],
  "enums": []
}