Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DeviceSecurity::isDeviceSecured, isRunOnSimulator documentation #950

Open
jtara opened this issue Mar 27, 2018 · 1 comment
Open

DeviceSecurity::isDeviceSecured, isRunOnSimulator documentation #950

jtara opened this issue Mar 27, 2018 · 1 comment
Assignees

Comments

@jtara
Copy link

jtara commented Mar 27, 2018

Filing these here because rhomobile-docs project doesn't seem to be updated.

Documentation for isRunOnSimulator and isDeviceSecured is incorrect.

  • isRunOnSimulator also applies to iOS, and returns true if run on Apple simulator. (I have not tested with RhoSimulator). Probably really moot, since simulator on iOS only runs with specially-built X86 image and would never apply with distributed application.

  • isDeviceSecured description should be reworded a bit, since simulator check is included on iOS.

All of the methods are actually available on iOS, but of course those that are not applicable return false. It might be good to mention this in the documentation, as it will save developers the trouble of writing conditional code.

@jtara
Copy link
Author

jtara commented Mar 29, 2018

I noticed another couple of issues with the documentation as well.

Documentation states that isDeviceSecured checks for installer issues. It does not. It will return true even if installer issue. You need to check for installer issue separately.

As well, I notice there is no link for DeviceSecurity under APIs. However, it is present in the left sidebar. It would be good to check for other APIs missing in the main list that are listed in the sidebar.

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

No branches or pull requests

2 participants