StanfordSpezi / SpeziAccount

The Spezi Account module to enable login and signup functionality
https://swiftpackageindex.com/StanfordSpezi/SpeziAccount/documentation/
MIT License
5 stars 5 forks source link

Invitation Code Functionality #34

Open PSchmiedmayer opened 1 year ago

PSchmiedmayer commented 1 year ago

Problem

Some applications require the usage of an innovation code to participate in an application. The invitation code must be verified and correlated with some additional information about the user, including identifiable information like the date of birth or name.

Solution

A module providing an invitation code module should provide the following functionality:

  1. Provide a way to define the invitation code, e.g., using a regex expression that can be verified
  2. Provide a UI to display the invitation code and additional configurable identifiable information
  3. Provide a mocking mechanism to test the behavior locally or for UI tests in an application using Spezi

Additional context

Feel free to use this issue to debate the best design for the API as well as the user interface and your plans to implement the module. We are happy to provide help and support for developing the module.

The functionality should be embedded in the Spezi Account module sign-in flow, but UI elements should also be available to be reused independently of the Account Module in case the elements want to be implemented independent of an Account setup, e.g., allow users to enroll in different studies in the Spezi Study Application hosting multiple applications.

Code of Conduct

PSchmiedmayer commented 9 months ago

As discussed with @Supereg, this module might rather be a part of the Spezi Account module. We will move this issue over the Spezi Account.