@okode/capacitor-plugin-secure-share/dist/docs.json

Capacitor Secure Share Plugin

{
  "api": {
    "name": "SecureSharePlugin",
    "slug": "secureshareplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "save",
        "signature": "(data: Record<string, string>) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "string to string map holding the data to be saved",
            "type": "Record<string, string>"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "description",
            "text": "Save data to be shared to other apps."
          },
          {
            "name": "param",
            "text": "data string to string map holding the data to be saved"
          },
          {
            "name": "returns",
            "text": "A promise of void"
          },
          {
            "name": "errors",
            "text": "Error message from the cordova plugin"
          }
        ],
        "docs": "",
        "complexTypes": [
          "Record"
        ],
        "slug": "save"
      },
      {
        "name": "retrieve",
        "signature": "() => Promise<Record<string, string>>",
        "parameters": [],
        "returns": "Promise<Record<string, string>>",
        "tags": [
          {
            "name": "description",
            "text": "Get data saved in secure share storage"
          },
          {
            "name": "returns",
            "text": "A promise of a string to string map with the data saved. An empty map will be returned if no data is found"
          },
          {
            "name": "errors",
            "text": "Error message from the cordova plugin"
          }
        ],
        "docs": "",
        "complexTypes": [
          "Record"
        ],
        "slug": "retrieve"
      },
      {
        "name": "retrieveFrom",
        "signature": "(data: { packageName: string; }) => Promise<Record<string, string>>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ packageName: string; }"
          }
        ],
        "returns": "Promise<Record<string, string>>",
        "tags": [
          {
            "name": "description",
            "text": "Get data saved in secure share storage"
          },
          {
            "name": "param",
            "text": "pacakgeName package to retrieve shared data from"
          },
          {
            "name": "returns",
            "text": "A promise of a string to string map with the data saved"
          },
          {
            "name": "errors",
            "text": "Error message from the cordova plugin"
          }
        ],
        "docs": "",
        "complexTypes": [
          "Record"
        ],
        "slug": "retrievefrom"
      }
    ],
    "properties": []
  },
  "interfaces": [],
  "enums": [],
  "typeAliases": [
    {
      "name": "Record",
      "slug": "record",
      "docs": "Construct a type with a set of properties K of type T",
      "types": [
        {
          "text": "{\r\n    [P in K]: T;\r\n}",
          "complexTypes": [
            "K",
            "T"
          ]
        }
      ]
    }
  ],
  "pluginConfigs": []
}