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

Updated API reference (markdown)

Eugene Fox
2024-09-18 16:10:16 +03:00
parent 5f5162727b
commit 287e3e355f
+31 -26
@@ -1,30 +1,35 @@
## Namespaces
| Namespace | Description |
| --------- | ----------- |
| [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](#SimpleOTPModels) | Namespace with data object models |
| [SimpleOTP.Enums](#SimpleOTPEnums) | Namespace with type enumerations |
| [SimpleOTP.Helpers](#SimpleOTPHelpers) | Namespace with supplementary service classes |
## EugeneFox.SimpleOTP package
## 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**
- [HashAlgorithmProviders](./simpleotp.hashalgorithmproviders.md)
- [Hotp](./simpleotp.hotp.md)
- [Otp](./simpleotp.otp.md)
- [OtpAlgorithm](./simpleotp.otpalgorithm.md)
- [OtpCode](./simpleotp.otpcode.md)
- [OtpConfig](./simpleotp.otpconfig.md)
- [OtpSecret](./simpleotp.otpsecret.md)
- [OtpType](./simpleotp.otptype.md)
- [OtpUriFormat](./simpleotp.otpuriformat.md)
- [ToleranceSpan](./simpleotp.tolerancespan.md)
- [Totp](./simpleotp.totp.md)
## 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.Converters**
- [OtpAlgorithmJsonConverter](./simpleotp.converters.otpalgorithmjsonconverter.md)
- [OtpCodeJsonConverter](./simpleotp.converters.otpcodejsonconverter.md)
- [OtpConfigJsonConverter](./simpleotp.converters.otpconfigjsonconverter.md)
- [OtpSecretJsonConverter](./simpleotp.converters.otpsecretjsonconverter.md)
## 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.Encoding**
- [Base32Encoder](./simpleotp.encoding.base32encoder.md)
- [IEncoder](./simpleotp.encoding.iencoder.md)
## SimpleOTP.Helpers
| Class | Description |
| ----- | ----------- |
| [SecretGenerator](https://github.com/XFox111/SimpleOTP/wiki/SecretGenerator) | Helper class for OTP secret generation. |
- **SimpleOTP.Fluent**
- [OtpBuilder](./simpleotp.fluent.otpbuilder.md)
- [OtpConfigBuilder](./simpleotp.fluent.otpconfigbuilder.md)
- [OtpConfigFluentExtensions](./simpleotp.fluent.otpconfigfluentextensions.md)
- [OtpFluentExtensions](./simpleotp.fluent.otpfluentextensions.md)
## EugeneFox.SimpleOTP.DependencyInjection package
> [!NOTE]
This section is still in development.