search

corona-warn-app / cwa-documentation

Project overview, general documentation, and white papers. The CWA development ends on May 31, 2023. You still can warn other users until April 30, 2023. More information:
https://coronawarn.app/en/faq/#ramp_down
Apache License 2.0
3.28k stars 345 forks source link

[Overview] References, e.g. error codes #499

Open dsarkar opened 3 years ago

dsarkar commented 3 years ago

Index

Apple/iOS EN error codes Google/Android EN error codes

Questions on the downloaded keys

Corona-Warn-App Open Source Team

MikeMcC399 commented 3 years ago

@dsarkar Somehow I deleted the comment

For the sake of readability I edited out the comments in https://github.com/corona-warn-app/cwa-documentation/issues/499#issuecomment-753604516 so it is left as a reference positing.

You could also hide or delete the posting https://github.com/corona-warn-app/cwa-documentation/issues/499#issuecomment-753600214 you marked as obsolete, again for the sake of readability.

Ein-Tim commented 3 years ago

Apple/iOS ENError codes

The codes can also be found here, in the official developer documentation from Apple.

1 unknown
Failure has an unknown cause. GitHub issues: FAQ/workaround:

2 badParameter
The parameter is missing or incorrect. GitHub issues: https://github.com/corona-warn-app/cwa-app-ios/issues/1353, https://github.com/corona-warn-app/cwa-app-ios/pull/1359 FAQ/workaround: https://www.coronawarn.app/en/faq/#ios_black_screen

3 notEntitled
Process of calling is not entitled. GitHub issues: FAQ/workaround:

4 notAuthorized
The user has denied access to the notification framework. GitHub issues: FAQ/workaround:

5 unsupported Operation is not supported. GitHub issues: https://github.com/corona-warn-app/cwa-app-ios/issues/766 FAQ/workaround: https://www.coronawarn.app/en/faq/#ENError5

6 invalidated
A call to invalidate before the operation completes normally. GitHub issues: FAQ/workaround:

7 bluetoothOff
Bluetooth is turned off. GitHub issues: FAQ/workaround:

8 insufficientStorage
The storage is insufficient to enable notifications. GitHub issues: FAQ/workaround:

9 notEnabled
Notification is not enabled. GitHub issues: FAQ/workaround:

10 apiMisuse
The API use is incorrect. GitHub issues: FAQ/workaround:

11 'internal'
A bug in the internal notification framework. GitHub issues: https://github.com/corona-warn-app/cwa-app-ios/issues/759, https://github.com/corona-warn-app/cwa-app-ios/issues/972, https://github.com/corona-warn-app/cwa-app-ios/issues/976, https://github.com/corona-warn-app/cwa-app-ios/issues/983, https://github.com/corona-warn-app/cwa-app-ios/issues/1284, https://github.com/corona-warn-app/cwa-app-ios/issues/1296, FAQ/workaround: https://github.com/corona-warn-app/cwa-website/issues/244, https://www.coronawarn.app/en/faq/#ENError11

12 insufficientMemory
The memory is insufficient to perform the operation. GitHub issues: FAQ/workaround:

13 rateLimited
API calls are too frequent. GitHub issues: https://github.com/corona-warn-app/cwa-app-ios/issues/759, https://github.com/corona-warn-app/cwa-app-ios/issues/1353, https://github.com/corona-warn-app/cwa-app-ios/issues/1715 FAQ/workaround: https://www.coronawarn.app/en/faq/#ENError13

14 restricted
Exposure notification is disabled due to system policies. GitHub issues: FAQ/workaround:

15 badFormat
A file is formatted incorrectly. GitHub issues: FAQ/workaround:

16 dataInaccessible
The user must unlock the device before it can access data. GitHub issues: https://github.com/corona-warn-app/cwa-app-ios/issues/1000, https://github.com/corona-warn-app/cwa-app-ios/pull/1608, FAQ/workaround:

17 travelStatusNotAvailable
The system can’t determine whether the user is traveling. GitHub issues: FAQ/workaround:

GitHub issues/pull requests related to iOS error handling in general:

Ein-Tim commented 3 years ago

To be deleted afterwards

@dsarkar you could update the index and (if you don't plan to use this for Android error codes too) you could change the title to iOS error codes only (move to iOS Repo?). @MikeMcC399 Maybe you could delete this comment for better readability.

Thank you!

dsarkar commented 3 years ago

@MikeMcC399 @Ein-Tim Apparently by mistake I deleted @MikeMcC399 comment with the android codes. Very sorry about it. I will write it down again.

MikeMcC399 commented 3 years ago

@dsarkar Have you considered using https://github.com/corona-warn-app/cwa-app-android/wiki to set up and maintain such a list?

It seems that (mis-)using https://github.com/corona-warn-app/cwa-documentation/issues doesn't really lend itself to cleanly maintaining information like this.

dsarkar commented 3 years ago

@MikeMcC399 Wiki seems like the correct approach. Will check internally. We still can use the issues to maintain the wiki (mirror issue to wiki after community feedback.).

dsarkar commented 3 years ago

@MikeMcC399 we had a quick look into the wiki approach:

MikeMcC399 commented 3 years ago

@dsarkar If you use wikis just for content which does not change much, like references to error messages, I think that could work. If that doesn't actually work well, we could create one or more new .md documents and use that method instead.

MikeMcC399 commented 3 years ago

@dsarkar If this is going to be about iOS and Android error codes, it might be better to add a new Wiki to each of the corresponding app repos where the information belongs more logically. The documentation repo is more generic in most cases.

MikeMcC399 commented 2 years ago

@dsarkar

The link to the Google ExposureNotificationStatusCodes was never replaced here and apparently nobody noticed.

Probably in the meantime the CWA Android app handles the error codes well and does not normally expose the user to strange / unexplained error codes any more.