Class NumberIds

Namespace

Acuit.Pinpoint.Common.BarCodes

Assembly

Acuit.Pinpoint.Common.dll

Standard Acuit Pinpoint bar code number identifiers.

public static class NumberIds

Inheritance

object

NumberIds

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

These are the number identifiers used by Acuit Pinpoint, but plug-ins and other clients can define their own identifiers for their own use.

Fields

ModelNumber

The identifier for model numbers.

public const string ModelNumber = "model"

Field Value

string

SerialNumber

The identifier for serial numbers.

public const string SerialNumber = "serial"

Field Value

string

UnitModelNumber

The identifier for unit model numbers.

public const string UnitModelNumber = "unitModel"

Field Value

string

Properties

ValidIds

Gets the collection of number identifiers used by Acuit Pinpoint.

public static IEnumerable<string> ValidIds { get; }

Property Value

IEnumerable<string>

Methods

IsValid(string)

Gets whether a number identifier is a valid number identifier.

public static bool IsValid(string id)

Parameters

id string

The number identifier.

Returns

bool

true if the number identifier is valid; otherwise, false.

Remarks

This will validate that the number identifier matches one in ValidIds.

IsValid(string, IEnumerable<string>)

Gets whether a number identifier is a valid number identifier.

public static bool IsValid(string id, IEnumerable<string> validNumberIds)

Parameters

id string

The number identifier.

validNumberIds IEnumerable<string>

An optional list of identifiers that will be used to validate the number identifier. If this is null, the number identifiers will not be validated.

Returns

bool

true if the number identifier is valid; otherwise, false.