@jonz94/capacitor-sim/dist/docs.json

Capacitor plugin to get information from device's sim cards

{
  "api": {
    "name": "SimPlugin",
    "slug": "simplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "getSimCards",
        "signature": "() => Promise<GetSimCardsResult>",
        "parameters": [],
        "returns": "Promise<GetSimCardsResult>",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Get information from device's sim cards.",
        "complexTypes": [
          "GetSimCardsResult"
        ],
        "slug": "getsimcards"
      },
      {
        "name": "checkPermissions",
        "signature": "() => Promise<PermissionStatus>",
        "parameters": [],
        "returns": "Promise<PermissionStatus>",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Check permission to get information from device's sim cards.\n\nOn iOS the status is always granted.",
        "complexTypes": [
          "PermissionStatus"
        ],
        "slug": "checkpermissions"
      },
      {
        "name": "requestPermissions",
        "signature": "() => Promise<PermissionStatus>",
        "parameters": [],
        "returns": "Promise<PermissionStatus>",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Request permission to get information from device's sim cards.\n\nOn iOS the status is always granted.",
        "complexTypes": [
          "PermissionStatus"
        ],
        "slug": "requestpermissions"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "GetSimCardsResult",
      "slug": "getsimcardsresult",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "simCards",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "SimCard"
          ],
          "type": "SimCard[]"
        }
      ]
    },
    {
      "name": "SimCard",
      "slug": "simcard",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "number",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Android only: Phone number.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "allowsVOIP",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "iOS only: If this carrier allows VOIP calls to be made on its network.",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "carrierName",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The name of the cellular service provider.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "isoCountryCode",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Country code for the cellular service provider,\nrepresented as an ISO 3166-1 country code string.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "mobileCountryCode",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Mobile country code (MCC) for the cellular service provider,\nin its numeric representation.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "mobileNetworkCode",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Mobile network code (MNC) for the cellular service provider,\nin its numeric representation.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "PermissionStatus",
      "slug": "permissionstatus",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "readSimCard",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "PermissionState"
          ],
          "type": "PermissionState"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [
    {
      "name": "PermissionState",
      "slug": "permissionstate",
      "docs": "",
      "types": [
        {
          "text": "'prompt'",
          "complexTypes": []
        },
        {
          "text": "'prompt-with-rationale'",
          "complexTypes": []
        },
        {
          "text": "'granted'",
          "complexTypes": []
        },
        {
          "text": "'denied'",
          "complexTypes": []
        }
      ]
    }
  ],
  "pluginConfigs": []
}