CodeGlyphX logo
CodeGlyphX

API Reference

Class

HotpBuilder

Namespace CodeGlyphX.Otp
Assembly CodeGlyphX
Modifiers sealed

Fluent HOTP builder.

Inheritance

  • Object
  • HotpBuilder

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

Methods

public QrCode Encode() #
Returns: QrCode

Encodes the QR code.

public RenderedOutput Render(OutputFormat format, RenderExtras extras = null) #
Returns: RenderedOutput

Renders the configured HOTP QR code to the requested output format.

Parameters

format CodeGlyphX.Rendering.OutputFormat requiredposition: 0
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 1
Save 2 overloads
public String Save(String path, RenderExtras extras = null) #
Returns: String

Saves the configured HOTP QR code, selecting the output format from the file extension.

Parameters

path System.String requiredposition: 0
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 1
public Void Save(Stream stream, OutputFormat format, RenderExtras extras = null) #
Returns: Void

Writes the configured HOTP QR code to a stream in the requested output format.

Parameters

stream System.IO.Stream requiredposition: 0
format CodeGlyphX.Rendering.OutputFormat requiredposition: 1
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 2
public String Uri() #
Returns: String

Builds the otpauth URI.

public HotpBuilder WithOptions(Action<QrEasyOptions> configure) #
Returns: HotpBuilder

Updates rendering options.

Parameters

configure System.Action{CodeGlyphX.QrEasyOptions} requiredposition: 0
public HotpBuilder WithParameters(OtpAlgorithm algorithm, Int32 digits) #
Returns: HotpBuilder

Sets algorithm and digits.

Parameters

algorithm CodeGlyphX.OtpAlgorithm requiredposition: 0
digits System.Int32 requiredposition: 1

Properties

public QrEasyOptions Options { get; } #

Rendering options used by this builder.

public OtpAlgorithm Algorithm { get; set; } #

OTP algorithm.

public Int32 Digits { get; set; } #

OTP digits.

public Int64 Counter { get; set; } #

HOTP counter.