@cap-kit/rank 8.0.0

package/dist/docs.json

@@ -0,0 +1,441 @@
+{
+  "api": {
+    "name": "RankPlugin",
+    "slug": "rankplugin",
+    "docs": "Public JavaScript API for the Rank Capacitor plugin.\n\nThis interface defines a stable, platform-agnostic API.\nAll methods behave consistently across Android, iOS, and Web.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "isAvailable",
+        "signature": "() => Promise<AvailabilityResult>",
+        "parameters": [],
+        "returns": "Promise<AvailabilityResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise resolving to an AvailabilityResult object."
+          },
+          {
+            "name": "example",
+            "text": "```ts\nconst { value } = await Rank.isAvailable();\nif (value) {\n  // Show review prompt or related UI\n} else {\n  // Fallback behavior for unsupported platforms\n}\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Checks if the native In-App Review UI can be displayed.\nOn Android, it verifies Google Play Services availability.\nOn iOS, it checks the OS version compatibility.",
+        "complexTypes": [
+          "AvailabilityResult"
+        ],
+        "slug": "isavailable"
+      },
+      {
+        "name": "checkReviewEnvironment",
+        "signature": "() => Promise<ReviewEnvironmentResult>",
+        "parameters": [],
+        "returns": "Promise<ReviewEnvironmentResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Performs a diagnostic check to determine whether the\nGoogle Play In-App Review dialog can be displayed.\n\nThis does NOT trigger the review flow.\nAndroid-only. On other platforms, it resolves as unavailable.",
+        "complexTypes": [
+          "ReviewEnvironmentResult"
+        ],
+        "slug": "checkreviewenvironment"
+      },
+      {
+        "name": "requestReview",
+        "signature": "(options?: ReviewOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Optional review configuration overrides.",
+            "type": "ReviewOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Optional review configuration overrides."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the request is sent or completed."
+          },
+          {
+            "name": "example",
+            "text": "```ts\n// Basic usage with default configuration\nawait Rank.requestReview();\n\n// Usage with fire-and-forget behavior\nawait Rank.requestReview({ fireAndForget: true });\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Requests the display of the native review popup.\nOn Web, this operation calls unimplemented().",
+        "complexTypes": [
+          "ReviewOptions"
+        ],
+        "slug": "requestreview"
+      },
+      {
+        "name": "presentProductPage",
+        "signature": "(options?: StoreOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Store identification.",
+            "type": "StoreOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Store identification."
+          },
+          {
+            "name": "example",
+            "text": "```ts\n// On iOS, this will open an internal App Store overlay.\nawait Rank.presentProductPage({\n  appId: '123456789' // iOS App ID for URL generation\n});\n\n// On Android, this will redirect to the Play Store.\nawait Rank.presentProductPage({\n  packageName: 'com.example.app' // Android Package Name for URL generation\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Opens the App Store product page internally (iOS) or redirects to the Store (Android/Web).",
+        "complexTypes": [
+          "StoreOptions"
+        ],
+        "slug": "presentproductpage"
+      },
+      {
+        "name": "openStore",
+        "signature": "(options?: StoreOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Optional store identification overrides.",
+            "type": "StoreOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Optional store identification overrides."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the store application is launched."
+          },
+          {
+            "name": "example",
+            "text": "```ts\n// On Web, this will open the store page in a new tab if identifiers are provided.\nawait Rank.openStore({\n  appId: '123456789', // iOS App ID for URL generation\n  packageName: 'com.example.app' // Android Package Name for URL generation\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Opens the app's page in the App Store (iOS) or Play Store (Android).\nOn Web, it performs a URL redirect if parameters are provided.",
+        "complexTypes": [
+          "StoreOptions"
+        ],
+        "slug": "openstore"
+      },
+      {
+        "name": "openStoreListing",
+        "signature": "(options?: { appId?: string | undefined; } | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ appId?: string | undefined; } | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```ts\n// Opens the store listing page.\n// Uses the provided appId or falls back to the one in capacitor.config.ts\nawait Rank.openStoreListing({\n  appId: '123456789'\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Opens the App Store listing page for a specific app.\nIf no appId is provided, it uses the one from the plugin configuration.",
+        "complexTypes": [],
+        "slug": "openstorelisting"
+      },
+      {
+        "name": "search",
+        "signature": "(options: { terms: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ terms: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```ts\n// Searches the store for specific terms.\n// Android: market://search | iOS: itms-apps search\nawait Rank.search({\n  terms: 'Capacitor Plugins'\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Performs a search in the app store for the given terms.",
+        "complexTypes": [],
+        "slug": "search"
+      },
+      {
+        "name": "openDevPage",
+        "signature": "(options: { devId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ devId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options.devId On Android, this is the developer ID (numeric or string). On iOS, this is ignored."
+          },
+          {
+            "name": "example",
+            "text": "```ts\n// Navigates to a developer or brand page.\nawait Rank.openDevPage({\n  devId: '543216789'\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Opens the developer's page in the app store.",
+        "complexTypes": [],
+        "slug": "opendevpage"
+      },
+      {
+        "name": "openCollection",
+        "signature": "(options: { name: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ name: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "```ts\n// Opens a curated collection (Android only).\nawait Rank.openCollection({\n  name: 'editors_choice'\n});\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Opens a specific app collection (Android Only).",
+        "complexTypes": [],
+        "slug": "opencollection"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise resolving to the plugin version."
+          },
+          {
+            "name": "example",
+            "text": "```ts\nconst { version } = await Rank.getPluginVersion();\n```"
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Returns the native plugin version.\n\nThe returned version corresponds to the native implementation\nbundled with the application.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "AvailabilityResult",
+      "slug": "availabilityresult",
+      "docs": "Result object returned by the `isAvailable()` method.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "value",
+          "tags": [],
+          "docs": "Indicates whether the native In-App Review UI is available.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ReviewEnvironmentResult",
+      "slug": "reviewenvironmentresult",
+      "docs": "Diagnostic result for Android In-App Review availability.\n\nThis result describes whether the Google Play Review\nflow can actually be displayed in the current environment.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "canRequestReview",
+          "tags": [],
+          "docs": "True if the environment supports showing the review dialog.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "reason",
+          "tags": [],
+          "docs": "Optional diagnostic reason when the review dialog cannot be shown.",
+          "complexTypes": [],
+          "type": "'PLAY_STORE_NOT_AVAILABLE' | 'NOT_INSTALLED_FROM_PLAY_STORE' | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ReviewOptions",
+      "slug": "reviewoptions",
+      "docs": "Options for the `requestReview` method.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "fireAndForget",
+          "tags": [],
+          "docs": "Override the global configuration to determine if the promise\nshould resolve immediately or wait for the native flow.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StoreOptions",
+      "slug": "storeoptions",
+      "docs": "Options for the `openStore` method.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [],
+          "docs": "Runtime override for the Apple App ID on iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "packageName",
+          "tags": [],
+          "docs": "Runtime override for the Android Package Name.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Result object returned by the `getPluginVersion()` method.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "The native plugin version string.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": [
+    {
+      "name": "Rank",
+      "slug": "rank",
+      "properties": [
+        {
+          "name": "verboseLogging",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Enables verbose native logging.\n\nWhen enabled, additional debug information is printed\nto the native console (Logcat on Android, Xcode on iOS).",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "appleAppId",
+          "tags": [],
+          "docs": "The Apple App ID used for App Store redirection on iOS.\nExample: '123456789'\n* @since 8.0.0",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "androidPackageName",
+          "tags": [],
+          "docs": "The Android Package Name used for Play Store redirection.\nExample: 'com.example.app'\n* @since 8.0.0",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fireAndForget",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "If true, the `requestReview` method will resolve immediately\nwithout waiting for the native OS review flow to complete.\n* @default false",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ],
+      "docs": "Configuration options for the Rank plugin."
+    }
+  ]
+}