{
  "api": {
    "name": "BackgroundRunnerPlugin",
    "slug": "backgroundrunnerplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "checkPermissions",
        "signature": "() => any",
        "parameters": [],
        "returns": "any",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Check permissions for the various Capacitor device APIs.",
        "complexTypes": [
          "PermissionStatus"
        ],
        "slug": "checkpermissions"
      },
      {
        "name": "requestPermissions",
        "signature": "(options: RequestPermissionOptions) => any",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "RequestPermissionOptions"
          }
        ],
        "returns": "any",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Request permission to display local notifications.",
        "complexTypes": [
          "RequestPermissionOptions",
          "PermissionStatus"
        ],
        "slug": "requestpermissions"
      },
      {
        "name": "dispatchEvent",
        "signature": "<T = void>(options: DispatchEventOptions) => any",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "DispatchEventOptions"
          }
        ],
        "returns": "any",
        "tags": [
          {
            "name": "param",
            "text": "options"
          },
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Dispatches an event to the configured runner.",
        "complexTypes": [
          "DispatchEventOptions",
          "T"
        ],
        "slug": "dispatchevent"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'backgroundRunnerNotificationReceived', listenerFunc: (event: NotificationActionEvent) => void) => any",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'backgroundRunnerNotificationReceived'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "(event: NotificationActionEvent) => void"
          }
        ],
        "returns": "any",
        "tags": [
          {
            "name": "since",
            "text": "2.1.1"
          }
        ],
        "docs": "Add a listener for notification actions.",
        "complexTypes": [
          "NotificationActionEvent",
          "PluginListenerHandle"
        ],
        "slug": "addlistenerbackgroundrunnernotificationreceived-"
      },
      {
        "name": "removeNotificationListeners",
        "signature": "() => any",
        "parameters": [],
        "returns": "any",
        "tags": [
          {
            "name": "since",
            "text": "2.1.1"
          }
        ],
        "docs": "Remove notification action listeners for this plugin.",
        "complexTypes": [],
        "slug": "removenotificationlisteners"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "PermissionStatus",
      "slug": "permissionstatus",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "geolocation",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "PermissionState"
          ],
          "type": "PermissionState"
        },
        {
          "name": "notifications",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "PermissionState"
          ],
          "type": "PermissionState"
        }
      ]
    },
    {
      "name": "RequestPermissionOptions",
      "slug": "requestpermissionoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "apis",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "API"
          ],
          "type": "{}"
        }
      ]
    },
    {
      "name": "DispatchEventOptions",
      "slug": "dispatcheventoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "label",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The runner label to dispatch the event to",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "event",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The name of the registered event listener.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "details",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "{ [key: string]: any; }"
        }
      ]
    },
    {
      "name": "NotificationActionEvent",
      "slug": "notificationactionevent",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "actionTypeId",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "notificationId",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "number"
        }
      ]
    },
    {
      "name": "PluginListenerHandle",
      "slug": "pluginlistenerhandle",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "remove",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "() => any"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [
    {
      "name": "PermissionState",
      "slug": "permissionstate",
      "docs": "",
      "types": [
        {
          "text": "'prompt'",
          "complexTypes": []
        },
        {
          "text": "'prompt-with-rationale'",
          "complexTypes": []
        },
        {
          "text": "'granted'",
          "complexTypes": []
        },
        {
          "text": "'denied'",
          "complexTypes": []
        }
      ]
    },
    {
      "name": "API",
      "slug": "api",
      "docs": "",
      "types": [
        {
          "text": "'geolocation'",
          "complexTypes": []
        },
        {
          "text": "'notifications'",
          "complexTypes": []
        }
      ]
    }
  ],
  "pluginConfigs": [
    {
      "name": "BackgroundRunner",
      "slug": "backgroundrunner",
      "properties": [
        {
          "name": "label",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "\"com.example.background.task\"",
              "name": "example"
            }
          ],
          "docs": "The name of the runner, used in logs.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "src",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "\"runners/background.js\"",
              "name": "example"
            }
          ],
          "docs": "The path to the runner JavaScript file, relative to the app bundle.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "event",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "\"myCustomEvent\"",
              "name": "example"
            }
          ],
          "docs": "The name of the event that will be called when the OS executes the background task.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "repeat",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "true",
              "name": "example"
            }
          ],
          "docs": "If background task should repeat based on the interval set in `interval`.",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "interval",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "15",
              "name": "example"
            }
          ],
          "docs": "The number of minutes after the the app is put into the background in which the background task should begin.\n\nIf `repeat` is true, this also specifies the number of minutes between each execution.",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "autoStart",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            },
            {
              "text": "true",
              "name": "example"
            }
          ],
          "docs": "Automatically register and schedule background task on app load.",
          "complexTypes": [],
          "type": "boolean | undefined"
        }
      ],
      "docs": "On load, Background Runner will automatically register a\nbackground task that will be scheduled and run once your app is\nbackgrounded."
    }
  ]
}