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
2024-09-18 16:10:16 +03:00
parent 5f5162727b
commit 287e3e355f
1 changed files with 31 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API-reference.md
+31 -26
@@ -1,30 +1,35 @@
## Namespaces ## EugeneFox.SimpleOTP package
| 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 |
## SimpleOTP - **SimpleOTP**
| Class | Description | - [HashAlgorithmProviders](./simpleotp.hashalgorithmproviders.md)
| ----- | ----------- | - [Hotp](./simpleotp.hotp.md)
| [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) | Service class for generating and validating OTP codes. | - [Otp](./simpleotp.otp.md)
| [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) | Class used to streamline OTP code generation on client devices. | - [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 - **SimpleOTP.Converters**
| Class | Description | - [OtpAlgorithmJsonConverter](./simpleotp.converters.otpalgorithmjsonconverter.md)
| ----- | ----------- | - [OtpCodeJsonConverter](./simpleotp.converters.otpcodejsonconverter.md)
| [OTPCode](https://github.com/XFox111/SimpleOTP/wiki/OTPCode) | OTP code object model. | - [OtpConfigJsonConverter](./simpleotp.converters.otpconfigjsonconverter.md)
| [OTPConfiguration](https://github.com/XFox111/SimpleOTP/wiki/OTPConfiguration) | OTP generator configuration object. | - [OtpSecretJsonConverter](./simpleotp.converters.otpsecretjsonconverter.md)
## SimpleOTP.Enums - **SimpleOTP.Encoding**
| Class | Description | - [Base32Encoder](./simpleotp.encoding.base32encoder.md)
| ----- | ----------- | - [IEncoder](./simpleotp.encoding.iencoder.md)
| [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 - **SimpleOTP.Fluent**
| Class | Description | - [OtpBuilder](./simpleotp.fluent.otpbuilder.md)
| ----- | ----------- | - [OtpConfigBuilder](./simpleotp.fluent.otpconfigbuilder.md)
| [SecretGenerator](https://github.com/XFox111/SimpleOTP/wiki/SecretGenerator) | Helper class for OTP secret generation. | - [OtpConfigFluentExtensions](./simpleotp.fluent.otpconfigfluentextensions.md)
- [OtpFluentExtensions](./simpleotp.fluent.otpfluentextensions.md)
## EugeneFox.SimpleOTP.DependencyInjection package
> [!NOTE]
This section is still in development.