API Reference
Class
TotpBuilder
Fluent TOTP builder.
Inheritance
- Object
- TotpBuilder
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method Otp.Totp
- Method TotpBuilder.WithOptions
- Method TotpBuilder.WithParameters
Methods
public RenderedOutput Render(OutputFormat format, RenderExtras extras = null) #Returns:
RenderedOutputRenders the configured TOTP QR code to the requested output format.
Parameters
- format CodeGlyphX.Rendering.OutputFormat
- extras CodeGlyphX.Rendering.RenderExtras = null
Save 2 overloads
public String Save(String path, RenderExtras extras = null) #Returns:
StringSaves the configured TOTP QR code, selecting the output format from the file extension.
Parameters
- path System.String
- extras CodeGlyphX.Rendering.RenderExtras = null
public Void Save(Stream stream, OutputFormat format, RenderExtras extras = null) #Returns:
VoidWrites the configured TOTP QR code to a stream in the requested output format.
Parameters
- stream System.IO.Stream
- format CodeGlyphX.Rendering.OutputFormat
- extras CodeGlyphX.Rendering.RenderExtras = null
public TotpBuilder WithOptions(Action<QrEasyOptions> configure) #Returns:
TotpBuilderUpdates rendering options.
Parameters
- configure System.Action{CodeGlyphX.QrEasyOptions}
public TotpBuilder WithParameters(OtpAlgorithm algorithm, Int32 digits, Int32 period) #Returns:
TotpBuilderSets algorithm, digits, and period.
Parameters
- algorithm CodeGlyphX.OtpAlgorithm
- digits System.Int32
- period System.Int32
Inherited Methods
Properties
public QrEasyOptions Options { get; } #Rendering options used by this builder.