Gs1DigitalLink

Edit on GitHub

Namespace CodeGlyphX

Assembly CodeGlyphX

Source ../../../../_/CodeGlyphX/Gs1DigitalLink.cs:16

Modifiers static

Parses, validates, and builds uncompressed GS1 Digital Link URIs according to URI Syntax release 1.6.0.

Inheritance

Object
Gs1DigitalLink

Methods

public static Gs1DigitalLinkUri Build(String uriStem, IReadOnlyList<Gs1Element> elements, String primaryIdentifierAi = null, IReadOnlyDictionary<String, String> extensionParameters = null, String fragment = null, Gs1ValidationOptions validationOptions = null)

../../../../_/CodeGlyphX/Gs1DigitalLink.cs:50

Returns: Gs1DigitalLinkUri

Builds and validates a GS1 Digital Link URI on the supplied HTTP or HTTPS URI stem. Key qualifiers are placed in standards-defined path order and remaining GS1 attributes are sorted lexically in the query.

Parameters

uriStem System.String requiredposition: 0
elements System.Collections.Generic.IReadOnlyList{CodeGlyphX.Gs1Element} requiredposition: 1
primaryIdentifierAi System.String = null optionalposition: 2
extensionParameters System.Collections.Generic.IReadOnlyDictionary{System.String,System.String} = null optionalposition: 3
fragment System.String = null optionalposition: 4
validationOptions CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 5

BuildCanonical 2 overloads

public static Gs1DigitalLinkUri BuildCanonical(IReadOnlyList<Gs1Element> elements, String primaryIdentifierAi = null, Gs1ValidationOptions validationOptions = null)

../../../../_/CodeGlyphX/Gs1DigitalLink.cs:64

Returns: Gs1DigitalLinkUri

Builds the canonical GS1 Digital Link URI on https://id.gs1.org.

Parameters

elements System.Collections.Generic.IReadOnlyList{CodeGlyphX.Gs1Element} requiredposition: 0
primaryIdentifierAi System.String = null optionalposition: 1
validationOptions CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 2

public static Gs1DigitalLinkUri BuildCanonical(params Gs1Element[] elements) #

../../../../_/CodeGlyphX/Gs1DigitalLink.cs:75

Returns: Gs1DigitalLinkUri

Builds the canonical GS1 Digital Link URI on https://id.gs1.org.

Parameters

elements CodeGlyphX.Gs1Element[] requiredposition: 0

public static Gs1DigitalLinkUri Parse(String uri, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1DigitalLink.cs:22

Returns: Gs1DigitalLinkUri

Parses a valid uncompressed GS1 Digital Link URI.

Parameters

uri System.String requiredposition: 0
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 1

Exceptions

FormatException – The URI or its GS1 data is invalid.

public static Boolean TryParse(String uri, out Gs1DigitalLinkUri result, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1DigitalLink.cs:34

Returns: Boolean

Attempts to parse and fully validate an uncompressed GS1 Digital Link URI.

Parameters

uri System.String requiredposition: 0
result CodeGlyphX.Gs1DigitalLinkUri@ requiredposition: 1
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 2

public static Gs1DigitalLinkValidationResult Validate(String uri, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1DigitalLink.cs:16

Returns: Gs1DigitalLinkValidationResult

Parses and validates an uncompressed GS1 Digital Link URI while collecting all detectable issues.

Parameters

uri System.String requiredposition: 0
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 1

Inherited Methods

Fields

public const String SyntaxVersion #

Gets the implemented GS1 Digital Link URI Syntax release.

Value: 1.6.0