Documentation Request

[ct-jeffweinberg]

The template is not relevant to this request.

Please add the excellent documentation from (locationAuthorizationRequest)[https://transistorsoft.github.io/react-native-background-geolocation/interfaces/config.html#3--locationauthorizationrequest-39any39] in the generated API docs to a section in the Home page of the Wiki, or to the Philosophy of Operation section.

While this was my own experience and the best step would have been to thoroughly read the type annotations or the API docs, I found it hard to find relevant information on the idiosyncrasies of iOS location permissions and spent a good amount of time having to read through issues to find what I was looking for. I think that this is an important topic and worthy of its own place in the wiki as the content is already written in a convenient how to guide with code examples.

Thanks for your consideration.

[jrweinb]

Its also worth adding this to the Using the Plugin guide in the Readme:

From the generated docs here:

Warning: You must call #ready once and only once, each time your app is launched.
Do not hide the call to #ready within a view which is loaded only by clicking a UI action. This is particularly important for iOS in the case where the OS relaunches your app in the background when the device is detected to be moving. If you don't ensure that #ready is called in this case, tracking will not resume.

This is easy to miss and not doing it causes subtle bugs that are hard to find as the plugin still mostly works.

[christocracy]

Thanks for the feedback.

[christocracy]

• Added Location Authorization: WhenInUse vs Always section to Wiki Philosophy of Operation.
• Added two links to read the api docs in the README.

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[github-actions]

This issue was closed because it has been inactive for 14 days since being marked as stale.