CodeGlyphX logo
CodeGlyphX

API Reference

Class

OtpQrPreset

Namespace CodeGlyphX
Assembly CodeGlyphX
Modifiers static

Opinionated QR presets for OTP URIs.

Inheritance

  • Object
  • OtpQrPreset

Methods

public static QrPngRenderOptions CreatePngRenderOptions(Int32 moduleSize = 6, Int32 quietZone = 4, Nullable<Rgba32> foreground = null, Nullable<Rgba32> background = null) #
Returns: QrPngRenderOptions

Creates PNG render options optimized for OTP QR readability.

Parameters

moduleSize System.Int32 = 6 optionalposition: 0
quietZone System.Int32 = 4 optionalposition: 1
foreground System.Nullable{CodeGlyphX.Rendering.Png.Rgba32} = null optionalposition: 2
background System.Nullable{CodeGlyphX.Rendering.Png.Rgba32} = null optionalposition: 3
EncodeHotp 2 overloads
public static QrCode EncodeHotp(String issuer, String account, Byte[] secret, Int64 counter, OtpAlgorithm alg = Sha1, Int32 digits = 6, QrErrorCorrectionLevel ecc = H, Int32 minVersion = 1, Int32 maxVersion = 10, Nullable<Int32> forceMask = null) #
Returns: QrCode

Builds a HOTP otpauth:// URI and encodes it as a QR code.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secret System.Byte[] requiredposition: 2
counter System.Int64 requiredposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
ecc CodeGlyphX.QrErrorCorrectionLevel = H optionalposition: 6
minVersion System.Int32 = 1 optionalposition: 7
maxVersion System.Int32 = 10 optionalposition: 8
forceMask System.Nullable{System.Int32} = null optionalposition: 9
public static QrCode EncodeHotp(String issuer, String account, ReadOnlySpan<Byte> secret, Int64 counter, OtpAlgorithm alg = Sha1, Int32 digits = 6, QrErrorCorrectionLevel ecc = H, Int32 minVersion = 1, Int32 maxVersion = 10, Nullable<Int32> forceMask = null) #
Returns: QrCode

Builds a HOTP otpauth:// URI and encodes it as a QR code.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secret System.ReadOnlySpan{System.Byte} requiredposition: 2
counter System.Int64 requiredposition: 3
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 4
digits System.Int32 = 6 optionalposition: 5
ecc CodeGlyphX.QrErrorCorrectionLevel = H optionalposition: 6
minVersion System.Int32 = 1 optionalposition: 7
maxVersion System.Int32 = 10 optionalposition: 8
forceMask System.Nullable{System.Int32} = null optionalposition: 9
EncodeTotp 2 overloads
public static QrCode EncodeTotp(String issuer, String account, Byte[] secret, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30, QrErrorCorrectionLevel ecc = H, Int32 minVersion = 1, Int32 maxVersion = 10, Nullable<Int32> forceMask = null) #
Returns: QrCode

Builds a TOTP otpauth:// URI and encodes it as a QR code.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secret System.Byte[] requiredposition: 2
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 3
digits System.Int32 = 6 optionalposition: 4
period System.Int32 = 30 optionalposition: 5
ecc CodeGlyphX.QrErrorCorrectionLevel = H optionalposition: 6
minVersion System.Int32 = 1 optionalposition: 7
maxVersion System.Int32 = 10 optionalposition: 8
forceMask System.Nullable{System.Int32} = null optionalposition: 9
public static QrCode EncodeTotp(String issuer, String account, ReadOnlySpan<Byte> secret, OtpAlgorithm alg = Sha1, Int32 digits = 6, Int32 period = 30, QrErrorCorrectionLevel ecc = H, Int32 minVersion = 1, Int32 maxVersion = 10, Nullable<Int32> forceMask = null) #
Returns: QrCode

Builds a TOTP otpauth:// URI and encodes it as a QR code.

Parameters

issuer System.String requiredposition: 0
account System.String requiredposition: 1
secret System.ReadOnlySpan{System.Byte} requiredposition: 2
alg CodeGlyphX.OtpAlgorithm = Sha1 optionalposition: 3
digits System.Int32 = 6 optionalposition: 4
period System.Int32 = 30 optionalposition: 5
ecc CodeGlyphX.QrErrorCorrectionLevel = H optionalposition: 6
minVersion System.Int32 = 1 optionalposition: 7
maxVersion System.Int32 = 10 optionalposition: 8
forceMask System.Nullable{System.Int32} = null optionalposition: 9
public static QrCode EncodeUri(String otpauthUri, QrErrorCorrectionLevel ecc = H, Int32 minVersion = 1, Int32 maxVersion = 10, Nullable<Int32> forceMask = null) #
Returns: QrCode

Encodes a pre-built otpauth:// URI as a QR code.

Parameters

otpauthUri System.String requiredposition: 0
ecc CodeGlyphX.QrErrorCorrectionLevel = H optionalposition: 1
minVersion System.Int32 = 1 optionalposition: 2
maxVersion System.Int32 = 10 optionalposition: 3
forceMask System.Nullable{System.Int32} = null optionalposition: 4