Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion docs/apis/background-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ Visit [Don't kill my app!](https://dontkillmyapp.com) for more information on th

## Limitations of Background Tasks

Its not possible to run persistent, always running background services on mobile operating systems. Due to the limitations imposed by iOS and Android designed to reduce battery and data consumption, background tasks are constrained with various limitations that you must keep in mind while designing and implementing your background task.
It's not possible to run persistent, always running background services on mobile operating systems. Due to the limitations imposed by iOS and Android designed to reduce battery and data consumption, background tasks are constrained with various limitations that you must keep in mind while designing and implementing your background task.

### iOS

Expand All @@ -297,6 +297,8 @@ It’s not possible to run persistent, always running background services on mob
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions(...)`](#requestpermissions)
* [`dispatchEvent(...)`](#dispatchevent)
* [`addListener('backgroundRunnerNotificationReceived', ...)`](#addlistenerbackgroundrunnernotificationreceived-)
* [`removeNotificationListeners()`](#removenotificationlisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)

Expand Down Expand Up @@ -358,6 +360,41 @@ Dispatches an event to the configured runner.
--------------------


### addListener('backgroundRunnerNotificationReceived', ...)

```typescript
addListener(eventName: 'backgroundRunnerNotificationReceived', listenerFunc: (event: NotificationActionEvent) => void) => any
```

Add a listener for notification actions.

| Param | Type |
| ------------------ | ----------------------------------------------------------------------------------------------- |
| **`eventName`** | <code>'backgroundRunnerNotificationReceived'</code> |
| **`listenerFunc`** | <code>(event: <a href="#notificationactionevent">NotificationActionEvent</a>) =&gt; void</code> |

**Returns:** <code>any</code>

**Since:** 2.1.1

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


### removeNotificationListeners()

```typescript
removeNotificationListeners() => any
```

Remove notification action listeners for this plugin.

**Returns:** <code>any</code>

**Since:** 2.1.1

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


### Interfaces


Expand Down Expand Up @@ -385,6 +422,21 @@ Dispatches an event to the configured runner.
| **`details`** | <code>{ [key: string]: any; }</code> | | |


#### NotificationActionEvent

| Prop | Type |
| -------------------- | ------------------- |
| **`actionTypeId`** | <code>string</code> |
| **`notificationId`** | <code>number</code> |


#### PluginListenerHandle

| Prop | Type |
| ------------ | ------------------------- |
| **`remove`** | <code>() =&gt; any</code> |


### Type Aliases


Expand Down
4 changes: 2 additions & 2 deletions docs/apis/barcode-scanner.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ ext {
}
```

Note: Android with `ZXING` scanning library supports all formats, while `MLKIT` supports all but `MAXICODE`, `RSS_14`, `RSS_EXPANDED` and `UPC_EAN_EXTENSION` - using one of these in `hint` will default to scanning any format.
Note: Android with `ZXING` scanning library supports all formats, while `MLKIT` supports all except `MAXICODE`, `RSS_14`, `RSS_EXPANDED` and `UPC_EAN_EXTENSION` - using one of these in `hint` will default to scanning any format.

#### iOS

The barcode scanner uses the camera on the device. Ensure you configure the Privacy - Camera Usage Description in your Info.plist file so that your application can access the device's camera.

Note: iOS supports all formats but `MAXICODE` and `UPC_EAN_EXTENSION` - using them in `hint` will default to scanning any format. Also, Apple Vision does not distinguish between `UPC_A` and `EAN_13`, so specifying one of these in `hint` will allow to scan both.
Note: iOS supports all formats except `MAXICODE` and `UPC_EAN_EXTENSION` - using them in `hint` will default to scanning any format. Also, Apple Vision does not distinguish between `UPC_A` and `EAN_13`, so specifying one of these in `hint` will allow to scan both.

---

Expand Down
Loading