capacitor-piano-dmp/dist/docs.json

Piano Dmp integration for Capacitor JS

{
  "api": {
    "name": "PianoDmpPlugin",
    "slug": "pianodmpplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "sendPageView",
        "signature": "(options: PageViewOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "PageViewOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options"
          }
        ],
        "docs": "Send a pageview event. Pageview events are aggregated by Piano Insight. All collected pageview events are available\nfor analysis in Insight's web interface.",
        "complexTypes": [
          "PageViewOptions"
        ],
        "slug": "sendpageview"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "PageViewOptions",
      "slug": "pageviewoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "location",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "userParams",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "Record"
          ],
          "type": "Record<string, string>"
        },
        {
          "name": "customParams",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "Record"
          ],
          "type": "Record<string, string>"
        }
      ]
    }
  ],
  "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": [
    {
      "name": "PianoDmp",
      "slug": "pianodmp",
      "properties": [
        {
          "name": "siteId",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "\"12345678910\"",
              "name": "example"
            }
          ],
          "docs": "Identifier of the site for which current event will be reported",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "username",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "\"username@email.com\"",
              "name": "example"
            }
          ],
          "docs": "Piano API username",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "apiKey",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "\"KffnjdfUB23309fnndf\"",
              "name": "example"
            }
          ],
          "docs": "Piano API apiKey",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ],
      "docs": ""
    }
  ]
}