Skip to content

Commit 07f7ae3

Browse files
rdlabordlabo
committed
# Conflicts: # docs/apis/geolocation.md # docs/apis/haptics.md # docs/apis/keyboard.md # docs/main/getting-started/environment-setup.md
2 parents c0d4429 + 0b35f01 commit 07f7ae3

210 files changed

Lines changed: 24277 additions & 225 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/apis/action-sheet.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npx cap sync
2121

2222
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
2323

24-
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.12.0`)
24+
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.13.0`)
2525

2626
## PWA Notes
2727

‎docs/apis/background-runner.md‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Visit [Don't kill my app!](https://dontkillmyapp.com) for more information on th
277277

278278
## Limitations of Background Tasks
279279

280-
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.
280+
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.
281281

282282
### iOS
283283

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

@@ -358,6 +360,41 @@ Dispatches an event to the configured runner.
358360
--------------------
359361

360362

363+
### addListener('backgroundRunnerNotificationReceived', ...)
364+
365+
```typescript
366+
addListener(eventName: 'backgroundRunnerNotificationReceived', listenerFunc: (event: NotificationActionEvent) => void) => any
367+
```
368+
369+
Add a listener for notification actions.
370+
371+
| Param | Type |
372+
| ------------------ | ----------------------------------------------------------------------------------------------- |
373+
| **`eventName`** | <code>'backgroundRunnerNotificationReceived'</code> |
374+
| **`listenerFunc`** | <code>(event: <a href="#notificationactionevent">NotificationActionEvent</a>) =&gt; void</code> |
375+
376+
**Returns:** <code>any</code>
377+
378+
**Since:** 2.1.1
379+
380+
--------------------
381+
382+
383+
### removeNotificationListeners()
384+
385+
```typescript
386+
removeNotificationListeners() => any
387+
```
388+
389+
Remove notification action listeners for this plugin.
390+
391+
**Returns:** <code>any</code>
392+
393+
**Since:** 2.1.1
394+
395+
--------------------
396+
397+
361398
### Interfaces
362399

363400

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

387424

425+
#### NotificationActionEvent
426+
427+
| Prop | Type |
428+
| -------------------- | ------------------- |
429+
| **`actionTypeId`** | <code>string</code> |
430+
| **`notificationId`** | <code>number</code> |
431+
432+
433+
#### PluginListenerHandle
434+
435+
| Prop | Type |
436+
| ------------ | ------------------------- |
437+
| **`remove`** | <code>() =&gt; any</code> |
438+
439+
388440
### Type Aliases
389441

390442

‎docs/apis/barcode-scanner.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ ext {
2727
}
2828
```
2929

30-
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.
30+
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.
3131

3232
#### iOS
3333

3434
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.
3535

36-
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.
36+
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.
3737

3838
---
3939

‎docs/apis/browser.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npx cap sync
2525

2626
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
2727

28-
- `androidxBrowserVersion`: version of `androidx.browser:browser` (default: `1.8.0`)
28+
- `androidxBrowserVersion`: version of `androidx.browser:browser` (default: `1.9.0`)
2929

3030
## Example
3131

‎docs/apis/camera.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ Additionally, because the Camera API launches a separate Activity to handle taki
7676

7777
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
7878

79-
- `androidxExifInterfaceVersion`: version of `androidx.exifinterface:exifinterface` (default: `1.3.7`)
80-
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.12.0`)
79+
- `androidxExifInterfaceVersion`: version of `androidx.exifinterface:exifinterface` (default: `1.4.1`)
80+
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.13.0`)
8181

8282
## PWA Notes
8383

@@ -152,7 +152,6 @@ pickImages(options: GalleryImageOptions) => Promise<GalleryPhotos>
152152
```
153153

154154
Allows the user to pick multiple pictures from the photo gallery.
155-
On iOS 13 and older it only allows to pick one picture.
156155

157156
| Param | Type |
158157
| ------------- | ------------------------------------------------------------------- |
@@ -171,9 +170,9 @@ On iOS 13 and older it only allows to pick one picture.
171170
pickLimitedLibraryPhotos() => Promise<GalleryPhotos>
172171
```
173172

174-
iOS 14+ Only: Allows the user to update their limited photo library selection.
175-
On iOS 15+ returns all the limited photos after the picker dismissal.
176-
On iOS 14 or if the user gave full access to the photos it returns an empty array.
173+
Allows the user to update their limited photo library selection.
174+
Returns all the limited photos after the picker dismissal.
175+
If instead the user gave full access to the photos it returns an empty array.
177176

178177
**Returns:** <code>Promise&lt;<a href="#galleryphotos">GalleryPhotos</a>&gt;</code>
179178

@@ -188,7 +187,7 @@ On iOS 14 or if the user gave full access to the photos it returns an empty arra
188187
getLimitedLibraryPhotos() => Promise<GalleryPhotos>
189188
```
190189

191-
iOS 14+ Only: Return an array of photos selected from the limited photo library.
190+
Return an array of photos selected from the limited photo library.
192191

193192
**Returns:** <code>Promise&lt;<a href="#galleryphotos">GalleryPhotos</a>&gt;</code>
194193

@@ -252,7 +251,7 @@ Request camera and photo album permissions
252251
| Prop | Type | Description | Default | Since |
253252
| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ----- |
254253
| **`quality`** | <code>number</code> | The quality of image to return as JPEG, from 0-100 Note: This option is only supported on Android and iOS | | 1.0.0 |
255-
| **`allowEditing`** | <code>boolean</code> | Whether to allow the user to crop or make small edits (platform specific). On iOS 14+ it's only supported for <a href="#camerasource">CameraSource.Camera</a>, but not for <a href="#camerasource">CameraSource.Photos</a>. | | 1.0.0 |
254+
| **`allowEditing`** | <code>boolean</code> | Whether to allow the user to crop or make small edits (platform specific). On iOS it's only supported for <a href="#camerasource">CameraSource.Camera</a>, but not for <a href="#camerasource">CameraSource.Photos</a>. | | 1.0.0 |
256255
| **`resultType`** | <code><a href="#cameraresulttype">CameraResultType</a></code> | How the data should be returned. Currently, only 'Base64', 'DataUrl' or 'Uri' is supported | | 1.0.0 |
257256
| **`saveToGallery`** | <code>boolean</code> | Whether to save the photo to the gallery. If the photo was picked from the gallery, it will only be saved if edited. | <code>: false</code> | 1.0.0 |
258257
| **`width`** | <code>number</code> | The desired maximum width of the saved image. The aspect ratio is respected. | | 1.0.0 |

0 commit comments

Comments
 (0)