CodeGlyphX logo
CodeGlyphX

API Reference

Class

Pdf417MacroAssembler

Namespace CodeGlyphX.Pdf417
Assembly CodeGlyphX
Modifiers sealed

Collects Macro PDF417 segments and assembles the original payload when complete.

Inheritance

  • Object
  • Pdf417MacroAssembler

Constructors

public Pdf417MacroAssembler() #

Methods

Add 2 overloads
public Void Add(CodeGlyphDecoded decoded) #
Returns: Void

Adds a decoded Macro PDF417 segment.

Parameters

decoded CodeGlyphX.Pdf417.Pdf417Decoded requiredposition: 0
Add(CodeGlyphX.CodeGlyphDecoded decoded) #

Adds a decoded Macro PDF417 segment from a CodeGlyphDecoded wrapper.

Parameters

decoded CodeGlyphX.CodeGlyphDecoded required
public String Assemble() #
Returns: String

Assembles the full payload when all segments are present.

TryAdd 3 overloads
public Boolean TryAdd(CodeGlyphDecoded decoded) #
Returns: Boolean

Attempts to add a decoded Macro PDF417 segment.

Parameters

decoded CodeGlyphX.Pdf417.Pdf417Decoded requiredposition: 0
TryAdd(CodeGlyphX.CodeGlyphDecoded decoded) #

Attempts to add a decoded Macro PDF417 segment from a CodeGlyphDecoded wrapper.

Parameters

decoded CodeGlyphX.CodeGlyphDecoded required
public Boolean TryAdd(String text, Pdf417MacroMetadata macro) #
Returns: Boolean

Attempts to add a Macro PDF417 segment with explicit metadata.

Parameters

text System.String requiredposition: 0
macro CodeGlyphX.Pdf417.Pdf417MacroMetadata requiredposition: 1
public Boolean TryAssemble(out String text) #
Returns: Boolean

Attempts to assemble the full payload when all segments are present.

Parameters

text System.String@ requiredposition: 0

Properties

public String FileId { get; } #

Gets the Macro PDF417 file identifier when known.

public Nullable<Int32> SegmentCount { get; } #

Gets the expected segment count when present in metadata.

public Boolean HasLastSegment { get; } #

Gets whether a segment flagged as the last segment was received.

public Nullable<Int32> LastSegmentIndex { get; } #

Gets the index of the last segment when known.

public Int32 ReceivedCount { get; } #

Gets the number of segments collected.

public String FileName { get; } #

Gets the file name when present.

public Nullable<Int64> Timestamp { get; } #

Gets the timestamp when present.

public String Sender { get; } #

Gets the sender when present.

public String Addressee { get; } #

Gets the addressee when present.

public Nullable<Int64> FileSize { get; } #

Gets the file size when present.

public Nullable<Int32> Checksum { get; } #

Gets the checksum when present.

public Boolean IsComplete { get; } #

Gets whether all expected segments have been collected.