@capawesome/capacitor-live-update/dist/docs.json

Capacitor plugin to update your app remotely in real-time.

{
  "api": {
    "name": "LiveUpdatePlugin",
    "slug": "liveupdateplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "deleteBundle",
        "signature": "(options: DeleteBundleOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "DeleteBundleOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Delete a bundle from the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "DeleteBundleOptions"
        ],
        "slug": "deletebundle"
      },
      {
        "name": "downloadBundle",
        "signature": "(options: DownloadBundleOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "DownloadBundleOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Download a bundle.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "DownloadBundleOptions"
        ],
        "slug": "downloadbundle"
      },
      {
        "name": "getBundle",
        "signature": "() => Promise<GetBundleResult>",
        "parameters": [],
        "returns": "Promise<GetBundleResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get the active bundle identifier.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetBundleResult"
        ],
        "slug": "getbundle"
      },
      {
        "name": "getBundles",
        "signature": "() => Promise<GetBundlesResult>",
        "parameters": [],
        "returns": "Promise<GetBundlesResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get all available bundle identifiers.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetBundlesResult"
        ],
        "slug": "getbundles"
      },
      {
        "name": "getChannel",
        "signature": "() => Promise<GetChannelResult>",
        "parameters": [],
        "returns": "Promise<GetChannelResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get the channel of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetChannelResult"
        ],
        "slug": "getchannel"
      },
      {
        "name": "getCustomId",
        "signature": "() => Promise<GetCustomIdResult>",
        "parameters": [],
        "returns": "Promise<GetCustomIdResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get the custom identifier of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetCustomIdResult"
        ],
        "slug": "getcustomid"
      },
      {
        "name": "getDeviceId",
        "signature": "() => Promise<GetDeviceIdResult>",
        "parameters": [],
        "returns": "Promise<GetDeviceIdResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get the device identifier of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetDeviceIdResult"
        ],
        "slug": "getdeviceid"
      },
      {
        "name": "getVersionCode",
        "signature": "() => Promise<GetVersionCodeResult>",
        "parameters": [],
        "returns": "Promise<GetVersionCodeResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get the version code of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetVersionCodeResult"
        ],
        "slug": "getversioncode"
      },
      {
        "name": "getVersionName",
        "signature": "() => Promise<GetVersionNameResult>",
        "parameters": [],
        "returns": "Promise<GetVersionNameResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Get the version name of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "GetVersionNameResult"
        ],
        "slug": "getversionname"
      },
      {
        "name": "ready",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Notify the plugin that the app is ready to use and no rollback is needed.\n\n**Attention**: This method should be called as soon as the app is ready to use\nto prevent the app from being reset to the default bundle.\n\nOnly available on Android and iOS.",
        "complexTypes": [],
        "slug": "ready"
      },
      {
        "name": "reload",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Reload the app to apply the new bundle.\n\nOnly available on Android and iOS.",
        "complexTypes": [],
        "slug": "reload"
      },
      {
        "name": "reset",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Reset the app to the default bundle.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
        "complexTypes": [],
        "slug": "reset"
      },
      {
        "name": "setBundle",
        "signature": "(options: SetBundleOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "SetBundleOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Set the next bundle to use for the app.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "SetBundleOptions"
        ],
        "slug": "setbundle"
      },
      {
        "name": "setChannel",
        "signature": "(options: SetChannelOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "SetChannelOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Set the channel of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "SetChannelOptions"
        ],
        "slug": "setchannel"
      },
      {
        "name": "setCustomId",
        "signature": "(options: SetCustomIdOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "SetCustomIdOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Set the custom identifier of the app.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "SetCustomIdOptions"
        ],
        "slug": "setcustomid"
      },
      {
        "name": "sync",
        "signature": "() => Promise<SyncResult>",
        "parameters": [],
        "returns": "Promise<SyncResult>",
        "tags": [
          {
            "name": "since",
            "text": "5.0.0"
          }
        ],
        "docs": "Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "SyncResult"
        ],
        "slug": "sync"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "DeleteBundleOptions",
      "slug": "deletebundleoptions",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "bundleId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'1.0.0'",
              "name": "example"
            }
          ],
          "docs": "The unique identifier of the bundle to delete.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "DownloadBundleOptions",
      "slug": "downloadbundleoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "bundleId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'1.0.0'",
              "name": "example"
            }
          ],
          "docs": "The unique identifier of the bundle.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "checksum",
          "tags": [
            {
              "text": "6.1.0",
              "name": "since"
            },
            {
              "text": "'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'",
              "name": "example"
            }
          ],
          "docs": "The checksum of the bundle to verify the integrity of the ZIP file.\n\nMust be a SHA-256 hash in hexadecimal format.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "url",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'https://example.com/bundle.zip'",
              "name": "example"
            }
          ],
          "docs": "The URL of the bundle to download.\n\nThe bundle must be a ZIP file containing at least a `index.html` file.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "GetBundleResult",
      "slug": "getbundleresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "bundleId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'1.0.0'",
              "name": "example"
            }
          ],
          "docs": "The unique identifier of the active bundle.\n\nIf `null`, the default bundle is being used.",
          "complexTypes": [],
          "type": "string | null"
        }
      ]
    },
    {
      "name": "GetBundlesResult",
      "slug": "getbundlesresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "bundleIds",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            }
          ],
          "docs": "An array of unique identifiers of all available bundles.",
          "complexTypes": [],
          "type": "string[]"
        }
      ]
    },
    {
      "name": "GetChannelResult",
      "slug": "getchannelresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "channel",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'production'",
              "name": "example"
            }
          ],
          "docs": "The channel of the app.\n\nIf `null`, the app is using the default channel.",
          "complexTypes": [],
          "type": "string | null"
        }
      ]
    },
    {
      "name": "GetCustomIdResult",
      "slug": "getcustomidresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "customId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'50d2a548-80b7-4dad-adc7-97c0e79d8a89'",
              "name": "example"
            }
          ],
          "docs": "The custom identifier of the app.\n\nIf `null`, no custom identifier is set.",
          "complexTypes": [],
          "type": "string | null"
        }
      ]
    },
    {
      "name": "GetDeviceIdResult",
      "slug": "getdeviceidresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "deviceId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'50d2a548-80b7-4dad-adc7-97c0e79d8a89'",
              "name": "example"
            }
          ],
          "docs": "The unique identifier of the device.\n\nOn iOS, [`identifierForVendor`](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor) is used.\nThe value of this property is the same for apps that come from the same vendor running on the same device.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "GetVersionCodeResult",
      "slug": "getversioncoderesult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "versionCode",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "\"1\"",
              "name": "example"
            }
          ],
          "docs": "The version code of the app.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "GetVersionNameResult",
      "slug": "getversionnameresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "versionName",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "\"1.0.0\"",
              "name": "example"
            }
          ],
          "docs": "The version name of the app.\n\nOn **Android**, this is the `versionName` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "SetBundleOptions",
      "slug": "setbundleoptions",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "bundleId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'1.0.0'",
              "name": "example"
            }
          ],
          "docs": "The unique identifier of the bundle to use.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "SetChannelOptions",
      "slug": "setchanneloptions",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "channel",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            }
          ],
          "docs": "The channel of the app.\n\nSet `null` to remove the channel.",
          "complexTypes": [],
          "type": "string | null"
        }
      ]
    },
    {
      "name": "SetCustomIdOptions",
      "slug": "setcustomidoptions",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "customId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            }
          ],
          "docs": "The custom identifier of the app.\n\nSet `null` to remove the custom identifier.",
          "complexTypes": [],
          "type": "string | null"
        }
      ]
    },
    {
      "name": "SyncResult",
      "slug": "syncresult",
      "docs": "",
      "tags": [
        {
          "text": "5.0.0",
          "name": "since"
        }
      ],
      "methods": [],
      "properties": [
        {
          "name": "nextBundleId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            }
          ],
          "docs": "The identifier of the next bundle to use.\n\nIf `null`, the app is up-to-date and no new bundle is available.",
          "complexTypes": [],
          "type": "string | null"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": [
    {
      "name": "LiveUpdate",
      "slug": "liveupdate",
      "properties": [
        {
          "name": "appId",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "'4100e356-e851-47fe-9d3c-b411eb325a99'",
              "name": "example"
            }
          ],
          "docs": "The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "autoDeleteBundles",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "false",
              "name": "default"
            }
          ],
          "docs": "Whether or not to automatically delete unused bundles.\n\nWhen enabled, the plugin will automatically delete unused bundles after calling `ready()`.",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "defaultChannel",
          "tags": [
            {
              "text": "6.3.0",
              "name": "since"
            },
            {
              "text": "'production'",
              "name": "example"
            }
          ],
          "docs": "The default channel of the app.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "enabled",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "true",
              "name": "default"
            }
          ],
          "docs": "Whether or not the plugin is enabled.",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "location",
          "tags": [
            {
              "text": "6.2.0",
              "name": "since"
            },
            {
              "text": "'us'",
              "name": "default"
            },
            {
              "text": "'eu'",
              "name": "example"
            },
            {
              "text": "https ://capawesome.io/cloud/live-updates/advanced/privacy/",
              "name": "see"
            }
          ],
          "docs": "The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).",
          "complexTypes": [],
          "type": "'us' | 'eu' | undefined"
        },
        {
          "name": "publicKey",
          "tags": [
            {
              "text": "6.1.0",
              "name": "since"
            },
            {
              "text": "'-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----'",
              "name": "example"
            }
          ],
          "docs": "The public key to verify the integrity of the bundle.\n\nThe public key must be a PEM-encoded RSA public key.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "readyTimeout",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "10000",
              "name": "default"
            }
          ],
          "docs": "The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "resetOnUpdate",
          "tags": [
            {
              "text": "5.0.0",
              "name": "since"
            },
            {
              "text": "true",
              "name": "default"
            }
          ],
          "docs": "Whether or not the app should be reset to the default bundle during an update.",
          "complexTypes": [],
          "type": "boolean | undefined"
        }
      ],
      "docs": ""
    }
  ]
}