xfox111/SimpleOTP
1
0
Fork 0
mirror of https://github.com/XFox111/SimpleOTP.git synced 2026-04-22 08:00:45 +03:00
Code Wiki Activity

Updated API reference (markdown)

Eugene Fox
2021-05-31 00:40:47 +03:00
parent e5e84a796c
commit 3b68a6f3f1
1 changed files with 28 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API-reference.md
+28 -4
@@ -1,6 +1,30 @@
## Namespaces
| Namespace | Description |
| --------- | ----------- |
| [SimpleOTP](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP) | Main namespace with [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) and [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) classes |
| [SimpleOTP.Models](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP.Models) | Namespace with data object models |
| [SimpleOTP.Enums](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP.Enums) | Namespace with type enumerations |
| [SimpleOTP.Helpers](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP.Helpers) | Namespace with supplementary service classes |
| [SimpleOTP](#SimpleOTP) | Main namespace with [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) and [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) classes |
| [SimpleOTP.Models](#SimpleOTP.Models) | Namespace with data object models |
| [SimpleOTP.Enums](#SimpleOTP.Enums) | Namespace with type enumerations |
| [SimpleOTP.Helpers](#SimpleOTP.Helpers) | Namespace with supplementary service classes |
## SimpleOTP
| Class | Description |
| ----- | ----------- |
| [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) | Service class for generating and validating OTP codes. |
| [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) | Class used to streamline OTP code generation on client devices. |
## SimpleOTP.Models
| Class | Description |
| ----- | ----------- |
| [OTPCode](https://github.com/XFox111/SimpleOTP/wiki/OTPCode) | OTP code object model. |
| [OTPConfiguration](https://github.com/XFox111/SimpleOTP/wiki/OTPConfiguration) | OTP generator configuration object. |
## SimpleOTP.Enums
| Class | Description |
| ----- | ----------- |
| [Algorithm](https://github.com/XFox111/SimpleOTP/wiki/Algorithm) | Available OTP encryption algorithms. |
| [OTPType](https://github.com/XFox111/SimpleOTP/wiki/OTPType) | OTP algorithm types. |
## SimpleOTP.Helpers
| Class | Description |
| ----- | ----------- |
| [SecretGenerator](https://github.com/XFox111/SimpleOTP/wiki/SecretGenerator) | Helper class for OTP secret generation. |