CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrPayloadData

Edit on GitHub
Namespace CodeGlyphX.Payloads
Assembly CodeGlyphX
Source CodeGlyphX/Payloads/QrPayloadData.cs:42
Modifiers sealed

QR payload with optional encoding/version defaults.

Inheritance

  • Object
  • QrPayloadData

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

Accepted by parameters

Constructors

public QrPayloadData(String text, Nullable<QrErrorCorrectionLevel> errorCorrectionLevel = null, Nullable<Int32> minVersion = null, Nullable<Int32> maxVersion = null, Nullable<QrTextEncoding> textEncoding = null) #
CodeGlyphX/Payloads/QrPayloadData.cs:42

Creates a payload with optional encoding/version defaults.

Parameters

text System.String requiredposition: 0
Payload text.
errorCorrectionLevel System.Nullable{CodeGlyphX.QrErrorCorrectionLevel} = null optionalposition: 1
Optional error correction level recommendation.
minVersion System.Nullable{System.Int32} = null optionalposition: 2
Optional minimum QR version.
maxVersion System.Nullable{System.Int32} = null optionalposition: 3
Optional maximum QR version.
textEncoding System.Nullable{CodeGlyphX.QrTextEncoding} = null optionalposition: 4
Optional text encoding recommendation.

Exceptions

  • ArgumentNullException – Thrown when text is null.

Methods

public override String ToString() #
CodeGlyphX/Payloads/QrPayloadData.cs:59
Returns: String

Returns the payload text.

Returns

Payload text.

Properties

public String Text { get; } #
CodeGlyphX/Payloads/QrPayloadData.cs:11

Payload text.

public Nullable<QrErrorCorrectionLevel> ErrorCorrectionLevel { get; } #
CodeGlyphX/Payloads/QrPayloadData.cs:16

Optional error correction level recommendation.

public Nullable<Int32> MinVersion { get; } #
CodeGlyphX/Payloads/QrPayloadData.cs:21

Optional minimum QR version.

public Nullable<Int32> MaxVersion { get; } #
CodeGlyphX/Payloads/QrPayloadData.cs:26

Optional maximum QR version.

public Nullable<QrTextEncoding> TextEncoding { get; } #
CodeGlyphX/Payloads/QrPayloadData.cs:31

Optional text encoding recommendation.