open-index/open-npm huggingface dataset:
npm package: @jonz94/capacitor-read-sms
Description: Capacitor Plugin to read SMS
Author: jonz94
Latest version: 0.0.1

# @jonz94/capacitor-read-sms

Capacitor Plugin to read SMS

## Install

```bash
npm install @jonz94/capacitor-read-sms
npx cap sync
```

## API

<docgen-index>

* [`getSMS(...)`](#getsms)
* [`checkPermission()`](#checkpermission)
* [`requestPermission()`](#requestpermission)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### getSMS(...)

```typescript
getSMS(options: { timestamp?: string; pageSize?: number; sender?: string; }) => Promise<{ value: SMS[]; }>
```

| Param         | Type                                                                     |
| ------------- | ------------------------------------------------------------------------ |
| **`options`** | <code>{ timestamp?: string; pageSize?: number; sender?: string; }</code> |

**Returns:** <code>Promise&lt;{ value: SMS[]; }&gt;</code>

--------------------


### checkPermission()

```typescript
checkPermission() => Promise<{ value: PERMISSION; }>
```

**Returns:** <code>Promise&lt;{ value: <a href="#permission">PERMISSION</a>; }&gt;</code>

--------------------


### requestPermission()

```typescript
requestPermission() => Promise<{ value: PERMISSION; }>
```

**Returns:** <code>Promise&lt;{ value: <a href="#permission">PERMISSION</a>; }&gt;</code>

--------------------


### Interfaces


#### SMS

| Prop                     | Type                |
| ------------------------ | ------------------- |
| **`_id`**                | <code>string</code> |
| **`thread_id`**          | <code>string</code> |
| **`address`**            | <code>string</code> |
| **`date`**               | <code>string</code> |
| **`date_sent`**          | <code>string</code> |
| **`protocol`**           | <code>string</code> |
| **`read`**               | <code>string</code> |
| **`status`**             | <code>string</code> |
| **`type`**               | <code>string</code> |
| **`reply_path_present`** | <code>string</code> |
| **`body`**               | <code>string</code> |
| **`error_code`**         | <code>string</code> |
| **`creator`**            | <code>string</code> |
| **`seen`**               | <code>string</code> |
| **`priority`**           | <code>string</code> |
| **`sequence_time`**      | <code>string</code> |
| **`server_time`**        | <code>string</code> |


### Type Aliases


#### PERMISSION

<code>'granted' | 'denied'</code>

</docgen-api>