{
  "api": {
    "name": "AppUpdatePlugin",
    "slug": "appupdateplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "getAppUpdateInfo",
        "signature": "(options?: GetAppUpdateInfoOptions | undefined) => Promise<AppUpdateInfo>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "GetAppUpdateInfoOptions | undefined"
          }
        ],
        "returns": "Promise<AppUpdateInfo>",
        "tags": [],
        "docs": "Returns app update informations.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "AppUpdateInfo",
          "GetAppUpdateInfoOptions"
        ],
        "slug": "getappupdateinfo"
      },
      {
        "name": "openAppStore",
        "signature": "(options?: OpenAppStoreOptions | undefined) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "OpenAppStoreOptions | undefined"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Opens the app store entry of the app in the Play Store (Android) or App Store (iOS).\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "OpenAppStoreOptions"
        ],
        "slug": "openappstore"
      },
      {
        "name": "performImmediateUpdate",
        "signature": "() => Promise<AppUpdateResult>",
        "parameters": [],
        "returns": "Promise<AppUpdateResult>",
        "tags": [],
        "docs": "Performs an immediate in-app update.\n\nOnly available on Android.",
        "complexTypes": [
          "AppUpdateResult"
        ],
        "slug": "performimmediateupdate"
      },
      {
        "name": "startFlexibleUpdate",
        "signature": "() => Promise<AppUpdateResult>",
        "parameters": [],
        "returns": "Promise<AppUpdateResult>",
        "tags": [],
        "docs": "Starts a flexible in-app update.\n\nOnly available on Android.",
        "complexTypes": [
          "AppUpdateResult"
        ],
        "slug": "startflexibleupdate"
      },
      {
        "name": "completeFlexibleUpdate",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Completes a flexible in-app update by restarting the app.\n\nOnly available on Android.",
        "complexTypes": [],
        "slug": "completeflexibleupdate"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => Promise<PluginListenerHandle>",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'onFlexibleUpdateStateChange'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "(state: FlexibleUpdateState) => void"
          }
        ],
        "returns": "Promise<PluginListenerHandle>",
        "tags": [],
        "docs": "Adds a flexbile in-app update state change listener.\n\nOnly available on Android.",
        "complexTypes": [
          "PluginListenerHandle",
          "FlexibleUpdateState"
        ],
        "slug": "addlisteneronflexibleupdatestatechange-"
      },
      {
        "name": "removeAllListeners",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Remove all listeners for this plugin.",
        "complexTypes": [],
        "slug": "removealllisteners"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "AppUpdateInfo",
      "slug": "appupdateinfo",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "currentVersionName",
          "tags": [
            {
              "text": "5.1.0",
              "name": "since"
            },
            {
              "text": "\"1.0.0\"",
              "name": "example"
            }
          ],
          "docs": "The current 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.\n\nOnly available on Android and iOS.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "availableVersionName",
          "tags": [
            {
              "text": "5.1.0",
              "name": "since"
            },
            {
              "text": "\"1.1.0\"",
              "name": "example"
            }
          ],
          "docs": "The available version name of the update.\n\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n\nOnly available on iOS.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "currentVersionCode",
          "tags": [
            {
              "text": "5.1.0",
              "name": "since"
            },
            {
              "text": "\"1\"",
              "name": "example"
            }
          ],
          "docs": "The current 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.\n\nOnly available on Android and iOS.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "availableVersionCode",
          "tags": [
            {
              "text": "5.1.0",
              "name": "since"
            },
            {
              "text": "\"2\"",
              "name": "example"
            }
          ],
          "docs": "The available version code of the update.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\n\nOnly available on Android.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "availableVersionReleaseDate",
          "tags": [],
          "docs": "Release date of the update in ISO 8601 (UTC) format.\n\nOnly available on iOS.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "updateAvailability",
          "tags": [],
          "docs": "The app update availability.\n\nOnly available on Android and iOS.",
          "complexTypes": [
            "AppUpdateAvailability"
          ],
          "type": "AppUpdateAvailability"
        },
        {
          "name": "updatePriority",
          "tags": [],
          "docs": "In-app update priority for this update, as defined by the developer in the Google Play Developer API.\n\nOnly available on Android.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "immediateUpdateAllowed",
          "tags": [],
          "docs": "`true` if an immediate update is allowed, otherwise `false`.\n\nOnly available on Android.",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "flexibleUpdateAllowed",
          "tags": [],
          "docs": "`true` if a flexible update is allowed, otherwise `false`.\n\nOnly available on Android.",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "clientVersionStalenessDays",
          "tags": [],
          "docs": "Number of days since the Google Play Store app on the user's device has learnt about an available update if an update is available or in progress.\n\nOnly available on Android.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "installStatus",
          "tags": [],
          "docs": "Flexible in-app update install status.\n\nOnly available on Android.",
          "complexTypes": [
            "FlexibleUpdateInstallStatus"
          ],
          "type": "FlexibleUpdateInstallStatus"
        },
        {
          "name": "minimumOsVersion",
          "tags": [],
          "docs": "The minimum version of the operating system required for the app to run in iOS.\n\nOnly available on iOS.",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "GetAppUpdateInfoOptions",
      "slug": "getappupdateinfooptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "country",
          "tags": [],
          "docs": "The two-letter country code for the store you want to search.\nSee http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for a list of ISO Country Codes.\n\nOnly available on iOS.",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "OpenAppStoreOptions",
      "slug": "openappstoreoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "androidPackageName",
          "tags": [
            {
              "text": "7.2.0",
              "name": "since"
            },
            {
              "text": "\"com.example.app\"",
              "name": "example"
            }
          ],
          "docs": "The package name of the app to open in the Play Store.\n\nOn **Android**, this is the application ID of your app\n(e.g. `com.example.app`).\nYou can find the ID in the `android/app/build.gradle` file.\n\nIf not provided, the current app's package name will be used.\n\nOnly available on Android.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "appId",
          "tags": [
            {
              "text": "6.1.0",
              "name": "since"
            },
            {
              "text": "\"com.example.app\"",
              "name": "example"
            },
            {
              "text": "\"123456789\"",
              "name": "example"
            }
          ],
          "docs": "The app ID of the app to open in the App Store.\n\nOn **iOS**, this is the Apple ID of your app (e.g. `123456789`).\nYou can find the ID in the URL of your app store entry\n(e.g. `https://apps.apple.com/app/id123456789`).\n\nOnly available on iOS.",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "AppUpdateResult",
      "slug": "appupdateresult",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "code",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "AppUpdateResultCode"
          ],
          "type": "AppUpdateResultCode"
        }
      ]
    },
    {
      "name": "PluginListenerHandle",
      "slug": "pluginlistenerhandle",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "remove",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "() => Promise<void>"
        }
      ]
    },
    {
      "name": "FlexibleUpdateState",
      "slug": "flexibleupdatestate",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "installStatus",
          "tags": [],
          "docs": "Flexible in-app update install status.",
          "complexTypes": [
            "FlexibleUpdateInstallStatus"
          ],
          "type": "FlexibleUpdateInstallStatus"
        },
        {
          "name": "bytesDownloaded",
          "tags": [],
          "docs": "Returns the number of bytes downloaded so far.\n`undefined` if the install status is other than `DOWNLOADING`.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "totalBytesToDownload",
          "tags": [],
          "docs": "Returns the total number of bytes to be downloaded for this update.\n`undefined` if the install status is other than `DOWNLOADING`.",
          "complexTypes": [],
          "type": "number | undefined"
        }
      ]
    }
  ],
  "enums": [
    {
      "name": "AppUpdateAvailability",
      "slug": "appupdateavailability",
      "members": [
        {
          "name": "UNKNOWN",
          "value": "0",
          "tags": [],
          "docs": ""
        },
        {
          "name": "UPDATE_NOT_AVAILABLE",
          "value": "1",
          "tags": [],
          "docs": ""
        },
        {
          "name": "UPDATE_AVAILABLE",
          "value": "2",
          "tags": [],
          "docs": ""
        },
        {
          "name": "UPDATE_IN_PROGRESS",
          "value": "3",
          "tags": [],
          "docs": ""
        }
      ]
    },
    {
      "name": "FlexibleUpdateInstallStatus",
      "slug": "flexibleupdateinstallstatus",
      "members": [
        {
          "name": "UNKNOWN",
          "value": "0",
          "tags": [],
          "docs": ""
        },
        {
          "name": "PENDING",
          "value": "1",
          "tags": [],
          "docs": ""
        },
        {
          "name": "DOWNLOADING",
          "value": "2",
          "tags": [],
          "docs": ""
        },
        {
          "name": "INSTALLING",
          "value": "3",
          "tags": [],
          "docs": ""
        },
        {
          "name": "INSTALLED",
          "value": "4",
          "tags": [],
          "docs": ""
        },
        {
          "name": "FAILED",
          "value": "5",
          "tags": [],
          "docs": ""
        },
        {
          "name": "CANCELED",
          "value": "6",
          "tags": [],
          "docs": ""
        },
        {
          "name": "DOWNLOADED",
          "value": "11",
          "tags": [],
          "docs": ""
        }
      ]
    },
    {
      "name": "AppUpdateResultCode",
      "slug": "appupdateresultcode",
      "members": [
        {
          "name": "OK",
          "value": "0",
          "tags": [],
          "docs": "The user has accepted the update."
        },
        {
          "name": "CANCELED",
          "value": "1",
          "tags": [],
          "docs": "The user has denied or cancelled the update."
        },
        {
          "name": "FAILED",
          "value": "2",
          "tags": [],
          "docs": "Some other error prevented either the user from providing consent or the update to proceed."
        },
        {
          "name": "NOT_AVAILABLE",
          "value": "3",
          "tags": [],
          "docs": "No update available."
        },
        {
          "name": "NOT_ALLOWED",
          "value": "4",
          "tags": [],
          "docs": "Update type not allowed."
        },
        {
          "name": "INFO_MISSING",
          "value": "5",
          "tags": [],
          "docs": "App update info missing.\nYou must call `getAppUpdateInfo()` before requesting an update."
        }
      ]
    }
  ],
  "typeAliases": [],
  "pluginConfigs": []
}