@capgo/capacitor-mute 7.2.0 → 7.3.0

package/README.md

@@ -52,6 +52,7 @@ If no answer I will add the code directly to capacitor-mute
 <docgen-index>
 
 * [`isMuted()`](#ismuted)
+* [`getPluginVersion()`](#getpluginversion)
 * [Interfaces](#interfaces)
 
 </docgen-index>
@@ -59,16 +60,35 @@ If no answer I will add the code directly to capacitor-mute
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+Capacitor Mute Plugin for detecting device mute status.
+
 ### isMuted()
 
 ```typescript
 isMuted() => Promise<MuteResponse>
 ```
 
-check if the device is muted
+Check if the device mute switch is enabled.
 
 **Returns:** <code>Promise&lt;<a href="#muteresponse">MuteResponse</a>&gt;</code>
 
+**Since:** 1.0.0
+
+--------------------
+
+
+### getPluginVersion()
+
+```typescript
+getPluginVersion() => Promise<{ version: string; }>
+```
+
+Get the native Capacitor plugin version.
+
+**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -77,12 +97,10 @@ check if the device is muted
 
 #### MuteResponse
 
-| Prop        | Type                 |
-| ----------- | -------------------- |
-| **`value`** | <code>boolean</code> |
+Response from mute status check.
 
-| Method               | Signature                                    | Description                             |
-| -------------------- | -------------------------------------------- | --------------------------------------- |
-| **getPluginVersion** | () =&gt; Promise&lt;{ version: string; }&gt; | Get the native Capacitor plugin version |
+| Prop        | Type                 | Description                              |
+| ----------- | -------------------- | ---------------------------------------- |
+| **`value`** | <code>boolean</code> | True if device is muted, false otherwise |
 
 </docgen-api>

package/android/src/main/java/ee/forgr/plugin/mute/MutePlugin.java

@@ -11,7 +11,7 @@ import com.getcapacitor.annotation.CapacitorPlugin;
 @CapacitorPlugin(name = "Mute")
 public class MutePlugin extends Plugin {
 
-    private final String PLUGIN_VERSION = "7.2.0";
+    private final String PLUGIN_VERSION = "7.3.0";
 
     @PluginMethod
     public void isMuted(PluginCall call) {

package/dist/docs.json

@@ -2,20 +2,69 @@
   "api": {
     "name": "MutePlugin",
     "slug": "muteplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "Capacitor Mute Plugin for detecting device mute status.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
     "methods": [
       {
         "name": "isMuted",
         "signature": "() => Promise<MuteResponse>",
         "parameters": [],
         "returns": "Promise<MuteResponse>",
-        "tags": [],
-        "docs": "check if the device is muted",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the mute status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if checking mute status fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { value } = await Mute.isMuted();\nif (value) {\n  console.log('Device is muted');\n} else {\n  console.log('Device is not muted');\n}\n```"
+          }
+        ],
+        "docs": "Check if the device mute switch is enabled.",
         "complexTypes": [
           "MuteResponse"
         ],
         "slug": "ismuted"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await Mute.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
       }
     ],
     "properties": []
@@ -24,34 +73,19 @@
     {
       "name": "MuteResponse",
       "slug": "muteresponse",
-      "docs": "",
-      "tags": [],
-      "methods": [
+      "docs": "Response from mute status check.",
+      "tags": [
         {
-          "name": "getPluginVersion",
-          "signature": "() => Promise<{ version: string; }>",
-          "parameters": [],
-          "returns": "Promise<{ version: string; }>",
-          "tags": [
-            {
-              "name": "returns",
-              "text": "an Promise with version for this device"
-            },
-            {
-              "name": "throws",
-              "text": "An error if the something went wrong"
-            }
-          ],
-          "docs": "Get the native Capacitor plugin version",
-          "complexTypes": [],
-          "slug": "getpluginversion"
+          "text": "1.0.0",
+          "name": "since"
         }
       ],
+      "methods": [],
       "properties": [
         {
           "name": "value",
           "tags": [],
-          "docs": "",
+          "docs": "True if device is muted, false otherwise",
           "complexTypes": [],
           "type": "boolean"
         }

package/dist/esm/definitions.d.ts

@@ -1,19 +1,48 @@
+/**
+ * Capacitor Mute Plugin for detecting device mute status.
+ *
+ * @since 1.0.0
+ */
 export interface MutePlugin {
     /**
-     * check if the device is muted
+     * Check if the device mute switch is enabled.
      *
+     * @returns Promise that resolves with the mute status
+     * @throws Error if checking mute status fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { value } = await Mute.isMuted();
+     * if (value) {
+     *   console.log('Device is muted');
+     * } else {
+     *   console.log('Device is not muted');
+     * }
+     * ```
      */
     isMuted(): Promise<MuteResponse>;
-}
-export interface MuteResponse {
-    value: boolean;
     /**
-     * Get the native Capacitor plugin version
+     * Get the native Capacitor plugin version.
      *
-     * @returns {Promise<{ id: string }>} an Promise with version for this device
-     * @throws An error if the something went wrong
+     * @returns Promise that resolves with the plugin version
+     * @throws Error if getting the version fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { version } = await Mute.getPluginVersion();
+     * console.log('Plugin version:', version);
+     * ```
      */
     getPluginVersion(): Promise<{
         version: string;
     }>;
 }
+/**
+ * Response from mute status check.
+ *
+ * @since 1.0.0
+ */
+export interface MuteResponse {
+    /** True if device is muted, false otherwise */
+    value: boolean;
+}

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface MutePlugin {\n  /**\n   * check if the device is muted\n   *\n   */\n  isMuted(): Promise<MuteResponse>;\n}\n\nexport interface MuteResponse {\n  value: boolean;\n\n  /**\n   * Get the native Capacitor plugin version\n   *\n   * @returns {Promise<{ id: string }>} an Promise with version for this device\n   * @throws An error if the something went wrong\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Capacitor Mute Plugin for detecting device mute status.\n *\n * @since 1.0.0\n */\nexport interface MutePlugin {\n  /**\n   * Check if the device mute switch is enabled.\n   *\n   * @returns Promise that resolves with the mute status\n   * @throws Error if checking mute status fails\n   * @since 1.0.0\n   * @example\n   * ```typescript\n   * const { value } = await Mute.isMuted();\n   * if (value) {\n   *   console.log('Device is muted');\n   * } else {\n   *   console.log('Device is not muted');\n   * }\n   * ```\n   */\n  isMuted(): Promise<MuteResponse>;\n\n  /**\n   * Get the native Capacitor plugin version.\n   *\n   * @returns Promise that resolves with the plugin version\n   * @throws Error if getting the version fails\n   * @since 1.0.0\n   * @example\n   * ```typescript\n   * const { version } = await Mute.getPluginVersion();\n   * console.log('Plugin version:', version);\n   * ```\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n\n/**\n * Response from mute status check.\n *\n * @since 1.0.0\n */\nexport interface MuteResponse {\n  /** True if device is muted, false otherwise */\n  value: boolean;\n}\n"]}

package/ios/Sources/MutePlugin/MutePlugin.swift

@@ -7,7 +7,7 @@ import Capacitor
  */
 @objc(MutePlugin)
 public class MutePlugin: CAPPlugin, CAPBridgedPlugin {
-    private let PLUGIN_VERSION: String = "7.2.0"
+    private let PLUGIN_VERSION: String = "7.3.0"
     public let identifier = "MutePlugin"
     public let jsName = "Mute"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-mute",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "Detect if the mute switch is enabled/disabled on a device",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",