@capgo/capacitor-crisp/dist/docs.json

Crisp native SDK for capacitor

{
  "api": {
    "name": "CapacitorCrispPlugin",
    "slug": "capacitorcrispplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "configure",
        "signature": "(data: { websiteID: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ websiteID: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "configure"
      },
      {
        "name": "openMessenger",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "openmessenger"
      },
      {
        "name": "setTokenID",
        "signature": "(data: { tokenID: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ tokenID: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "settokenid"
      },
      {
        "name": "setUser",
        "signature": "(data: { nickname?: string; phone?: string; email?: string; avatar?: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ nickname?: string | undefined; phone?: string | undefined; email?: string | undefined; avatar?: string | undefined; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "setuser"
      },
      {
        "name": "pushEvent",
        "signature": "(data: { name: string; color: eventColor; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ name: string; color: eventColor; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "eventColor"
        ],
        "slug": "pushevent"
      },
      {
        "name": "setCompany",
        "signature": "(data: { name: string; url?: string; description?: string; employment?: [title: string, role: string]; geolocation?: [country: string, city: string]; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ name: string; url?: string | undefined; description?: string | undefined; employment?: [title: string, role: string] | undefined; geolocation?: [country: string, city: string] | undefined; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "setcompany"
      },
      {
        "name": "setInt",
        "signature": "(data: { key: string; value: number; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ key: string; value: number; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "setint"
      },
      {
        "name": "setString",
        "signature": "(data: { key: string; value: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ key: string; value: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "setstring"
      },
      {
        "name": "sendMessage",
        "signature": "(data: { value: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ value: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "sendmessage"
      },
      {
        "name": "setSegment",
        "signature": "(data: { segment: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "data",
            "docs": "",
            "type": "{ segment: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "setsegment"
      },
      {
        "name": "reset",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "reset"
      }
    ],
    "properties": []
  },
  "interfaces": [],
  "enums": [],
  "typeAliases": [
    {
      "name": "eventColor",
      "slug": "eventcolor",
      "docs": "",
      "types": [
        {
          "text": "\"red\"",
          "complexTypes": []
        },
        {
          "text": "\"orange\"",
          "complexTypes": []
        },
        {
          "text": "\"yellow\"",
          "complexTypes": []
        },
        {
          "text": "\"green\"",
          "complexTypes": []
        },
        {
          "text": "\"blue\"",
          "complexTypes": []
        },
        {
          "text": "\"purple\"",
          "complexTypes": []
        },
        {
          "text": "\"pink\"",
          "complexTypes": []
        },
        {
          "text": "\"brown\"",
          "complexTypes": []
        },
        {
          "text": "\"grey\"",
          "complexTypes": []
        },
        {
          "text": "\"black\"",
          "complexTypes": []
        }
      ]
    }
  ],
  "pluginConfigs": []
}