API Reference

Class

TotpBuilder

Edit on GitHub

Namespace CodeGlyphX.Otp

Assembly CodeGlyphX

Source CodeGlyphX/Otp.cs:364

Modifiers sealed

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

Methods

public QrCode Encode() #

CodeGlyphX/Otp.cs:387

Returns: QrCode

Encodes the QR code.

public String Html() #

CodeGlyphX/Otp.cs:406

Returns: String

Renders HTML text.

public Byte[] Jpeg() #

CodeGlyphX/Otp.cs:411

Returns: Byte[]

Renders JPEG bytes.

public Byte[] Png() #

CodeGlyphX/Otp.cs:396

Returns: Byte[]

Renders PNG bytes.

public String Save(String path, String title = null) #

CodeGlyphX/Otp.cs:478

Returns: String

Saves based on file extension (.png/.webp/.svg/.html/.jpg). Defaults to PNG when no extension is provided.

Parameters

path System.String requiredposition: 0
title System.String = null optionalposition: 1

SaveHtml 2 overloads

public Void SaveHtml(Stream stream, String title = null) #

CodeGlyphX/Otp.cs:450

Returns: Void

Saves HTML to a file.

Parameters

path System.String requiredposition: 0
title System.String = null optionalposition: 1

SaveHtml(System.IO.Stream stream, System.String title) #

Saves HTML to a stream.

Parameters

stream System.IO.Stream required
title System.String required

SaveJpeg 2 overloads

public Void SaveJpeg(Stream stream) #

CodeGlyphX/Otp.cs:462

Returns: Void

Saves JPEG to a file.

Parameters

path System.String requiredposition: 0

SaveJpeg(System.IO.Stream stream) #

Saves JPEG to a stream.

Parameters

stream System.IO.Stream required

SavePng 2 overloads

public Void SavePng(Stream stream) #

CodeGlyphX/Otp.cs:426

Returns: Void

Saves PNG to a file.

Parameters

path System.String requiredposition: 0

SavePng(System.IO.Stream stream) #

Saves PNG to a stream.

Parameters

stream System.IO.Stream required

SaveSvg 2 overloads

public Void SaveSvg(Stream stream) #

CodeGlyphX/Otp.cs:436

Returns: Void

Saves SVG to a file.

Parameters

path System.String requiredposition: 0

SaveSvg(System.IO.Stream stream) #

Saves SVG to a stream.

Parameters

stream System.IO.Stream required

SaveWebp 2 overloads

public Void SaveWebp(Stream stream) #

CodeGlyphX/Otp.cs:472

Returns: Void

Saves WebP to a file.

Parameters

path System.String requiredposition: 0

SaveWebp(System.IO.Stream stream) #

Saves WebP to a stream.

Parameters

stream System.IO.Stream required

public String Svg() #

CodeGlyphX/Otp.cs:401

Returns: String

Renders SVG text.

public String Uri() #

CodeGlyphX/Otp.cs:382

Returns: String

Builds the otpauth URI.

public Byte[] Webp() #

CodeGlyphX/Otp.cs:416

Returns: Byte[]

Renders WebP bytes.

public TotpBuilder WithOptions(Action<QrEasyOptions> configure) #

CodeGlyphX/Otp.cs:364

Returns: TotpBuilder

Updates rendering options.

Parameters

configure System.Action{CodeGlyphX.QrEasyOptions} requiredposition: 0

public TotpBuilder WithParameters(OtpAlgorithm algorithm, Int32 digits, Int32 period) #

CodeGlyphX/Otp.cs:373

Returns: TotpBuilder

Sets algorithm, digits, and period.

Parameters

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

Inherited Methods

Properties

public QrEasyOptions Options { get; } #

CodeGlyphX/Otp.cs:336

Rendering options used by this builder.

public OtpAlgorithm Algorithm { get; set; } #

CodeGlyphX/Otp.cs:341

OTP algorithm.

public Int32 Digits { get; set; } #

CodeGlyphX/Otp.cs:346

OTP digits.

public Int32 Period { get; set; } #

CodeGlyphX/Otp.cs:351

TOTP period in seconds.