Skip to content

Conversation

@breautek
Copy link
Contributor

…ats of getPicture

Platforms affected

Documentation

Motivation and Context

Added notes mostly in regards to the public API changes for the return format of getPicture.
Also improved documentation surrounding best practices.

Description

  • Added notes about return formats in v8+
  • Added notes about the return formats used in v7 and earlier
  • Removed createFileEntry example, doesn't seem relevant to the camera plugin anymore.
  • Added copyTo example, as should be a common pattern starting in v8 moving forward.
  • Added upload example, using standard browser APIs.
  • Added example of how to render content when data uris used.
  • Added example of how to render content when file uri is used, via fileEntry.toURL()
  • Added notes indicating that returned file uris are temporary access grants only that typically only survive until the app is closed. For camera captures, this isn't completely true as app cache directory are used and it will survive much longer, but I feel it is easier to treat it as short-lived temporary for the purposes of illustrating the concept in general. (cleanup should be used anyway which will clean up these temporary files)
  • Added notes stating that the FILE_URI returns is an implementation detail, and they should not assume it will always be content:// or file://, etc... This is especially true for android devices.

Testing

VSCode markdown preview

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
  • I've updated the documentation if necessary

@breautek breautek added this to the 8.0.0 milestone Oct 26, 2024
@breautek breautek requested a review from erisu October 26, 2024 16:12
@breautek
Copy link
Contributor Author

Note that additional documentation will be added from #909 for making WRITE_EXTERNAL_STORAGE optional.

@breautek breautek merged commit 7d159cf into apache:master Oct 28, 2024
@breautek breautek deleted the docs/v8 branch October 28, 2024 17:01
KarinBerg added a commit to MobisysGmbH/mobisys-cordova-plugin-camera that referenced this pull request Feb 4, 2025
* chore: bump plugin version 7.0.0-dev (apache#845)
* dep(dev)!: bump @cordova/[email protected] (apache#846)
* dep(dev)!: bump @cordova/[email protected]
* chore: apply automatic lint fix
* feat(android)!: Android 13 support (apache#844)
* feat(android)!: Android 13 support
* refactor(android): simplify getPermissions logic
* feat(android)!: bump cordova-android requirement to >=12.0.0
* feat(android): update saveAlbumPermission to include Android 9 and below use case

---------

Co-authored-by: ochakov <[email protected]>

* chore: Update SUPPORT_QUESTION.md template (apache#849)

* fix!: remove deprecated platforms (apache#848)

* chore: remove windows/osx from plugin.xml (apache#850)

* ci(gh-action): sync with paramedic configs (apache#851)

* release(camera-v7.0.0): updated version and RELEASENOTES.md

* chore: bump version 7.0.1-dev

* ci(android): Update Android CI to be compatible with cordova-android@13 (apache#890)

* chore: Added npmrc

* ci: sync workflow with paramedic (apache#895)

* chore: Update eslint config to 5.1.0 (apache#898)

* chore: Update package to 8.0.0-dev (apache#899)

* Remove media permissions to make complaint with Android 14 requirements (apache#889)

Co-authored-by: Ravi Yakasiri <[email protected]>

* fix(android): Isolate provider access to a subdirectory (apache#901)

* fix(android): Use VERSION_CODES instead of hard-coded API literals (apache#904)

* fix(android): improper cache path construction during image manipulation (apache#905)

* fix(android): Improper serialization of image uri in save instance state (apache#903)

* fix(android): Return data uris as an URI (apache#910)

* fix: return content uris when possible when selecting from gallery (apache#902)

* fix(browser): Make data uri be returned as actual URI strings (apache#912)

* fix(ios): Sync camera API return to match Android changes (apache#911)

* refactor(android): replace image path usage with image uris (apache#906)

* refactor(android): clean up image file path usages

* removed references of image paths in log messages

* refactor(android): remove query img usage (apache#907)

* refactor: remove unnecessary duplicate image checks and queryImgDb usage

* remove unused imageType parameter, because it's a private API anyway

* docs: Revisions for v8 public API changes with the return string formats of getPicture (apache#913)

* refactor(android): Make WRITE_EXTERNAL_STORAGE optional (apache#909)

* refactor(android): Rework permission management to make WRITE_EXTERNAL_STORAGE optional

* removed unused getPermissions API

* Proper error if WRITE_EXTERNAL_STORAGE is required but missing the declaration

* removed obsolete hasPermissions API

* fix: Remove WRITE_EXTERNAL_PERMISSION (apache#915)

* deprecation: allowEdit (apache#914)

* deprecation: allowEdit

* applied suggestions to verbiage

* chore: version 8.0.0

* chore: 8.0.1-dev

* chore: remove trailing whitespace (apache#921)

* Change "allowedPublishingBranches" from "refs/heads/master" to "refs/heads/release"

* ci: Publish only the file "mobisys-internal-cordova-plugin-camera-*.tgz" to AzureDevOps

* ci: Use "release/v8" of "devops-templates"

* Add new section "Branches" to the README.md

---------

Co-authored-by: エリス <[email protected]>
Co-authored-by: ochakov <[email protected]>
Co-authored-by: jcesarmobile <[email protected]>
Co-authored-by: Erisu <[email protected]>
Co-authored-by: Norman Breau <[email protected]>
Co-authored-by: ravi-yk <[email protected]>
Co-authored-by: Ravi Yakasiri <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants