OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder Class Reference

Fluent builder for creating ExtendedDeviceIdentification instances. More...

Public Member Functions

ExtendedDeviceIdentificationBuilder WithManufacturer (string manufacturer)
 Sets the manufacturer name.
ExtendedDeviceIdentificationBuilder WithProductName (string productName)
 Sets the product name.
ExtendedDeviceIdentificationBuilder WithSerialNumber (string serialNumber)
 Sets the serial number.
ExtendedDeviceIdentificationBuilder WithFirmwareVersion (string firmwareVersion)
 Adds a firmware version.
ExtendedDeviceIdentificationBuilder WithHardwareDescription (string hardwareDescription)
 Sets the hardware description.
ExtendedDeviceIdentificationBuilder WithUrl (string url)
 Sets the URL.
ExtendedDeviceIdentificationBuilder WithConfigurationReference (string configurationReference)
 Sets the configuration reference.
ExtendedDeviceIdentificationBuilder WithEntry (ExtendedIdTag tag, string value)
 Adds a standard entry using a known tag.
ExtendedDeviceIdentificationBuilder WithCustomEntry (byte tagByte, string value)
 Adds a custom/vendor-specific entry using a raw tag byte.
ExtendedDeviceIdentificationBuilder WithEntry (ExtendedIdEntry entry)
 Adds a pre-constructed ExtendedIdEntry.
ExtendedDeviceIdentification Build ()
 Builds the immutable ExtendedDeviceIdentification instance.

Detailed Description

Fluent builder for creating ExtendedDeviceIdentification instances.

Provides a clean API for constructing extended ID responses with support for both standard and custom TLV entries.

Definition at line 9 of file ExtendedDeviceIdentificationBuilder.cs.

Member Function Documentation

◆ Build()

ExtendedDeviceIdentification OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.Build ( )
inline

Builds the immutable ExtendedDeviceIdentification instance.

Returns
A new ExtendedDeviceIdentification instance with all configured entries.

Definition at line 123 of file ExtendedDeviceIdentificationBuilder.cs.

◆ WithConfigurationReference()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithConfigurationReference ( string configurationReference)
inline

Sets the configuration reference.

Parameters
configurationReferenceThe configuration reference.
Returns
This builder instance for method chaining.

Definition at line 78 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().

◆ WithCustomEntry()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithCustomEntry ( byte tagByte,
string value )
inline

Adds a custom/vendor-specific entry using a raw tag byte.

Use this for vendor-specific extensions or tags not defined in the OSDP specification.

Parameters
tagByteThe custom tag byte value.
valueThe value for this entry.
Returns
This builder instance for method chaining.

Definition at line 102 of file ExtendedDeviceIdentificationBuilder.cs.

◆ WithEntry() [1/2]

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithEntry ( ExtendedIdEntry entry)
inline

Adds a pre-constructed ExtendedIdEntry.

Parameters
entryThe entry to add.
Returns
This builder instance for method chaining.

Definition at line 113 of file ExtendedDeviceIdentificationBuilder.cs.

◆ WithEntry() [2/2]

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithEntry ( ExtendedIdTag tag,
string value )
inline

Adds a standard entry using a known tag.

Parameters
tagThe standard tag type.
valueThe value for this entry.
Returns
This builder instance for method chaining.

Definition at line 89 of file ExtendedDeviceIdentificationBuilder.cs.

Referenced by WithConfigurationReference(), WithFirmwareVersion(), WithHardwareDescription(), WithManufacturer(), WithProductName(), WithSerialNumber(), and WithUrl().

◆ WithFirmwareVersion()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithFirmwareVersion ( string firmwareVersion)
inline

Adds a firmware version.

Multiple firmware versions can be added for devices with multiple microcontrollers.

Parameters
firmwareVersionThe firmware version string.
Returns
This builder instance for method chaining.

Definition at line 48 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().

◆ WithHardwareDescription()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithHardwareDescription ( string hardwareDescription)
inline

Sets the hardware description.

Parameters
hardwareDescriptionThe hardware description.
Returns
This builder instance for method chaining.

Definition at line 58 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().

◆ WithManufacturer()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithManufacturer ( string manufacturer)
inline

Sets the manufacturer name.

Parameters
manufacturerThe manufacturer name.
Returns
This builder instance for method chaining.

Definition at line 18 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().

◆ WithProductName()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithProductName ( string productName)
inline

Sets the product name.

Parameters
productNameThe product name.
Returns
This builder instance for method chaining.

Definition at line 28 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().

◆ WithSerialNumber()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithSerialNumber ( string serialNumber)
inline

Sets the serial number.

Parameters
serialNumberThe serial number.
Returns
This builder instance for method chaining.

Definition at line 38 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().

◆ WithUrl()

ExtendedDeviceIdentificationBuilder OSDP.Net.Model.ReplyData.ExtendedDeviceIdentificationBuilder.WithUrl ( string url)
inline

Sets the URL.

Parameters
urlThe URL.
Returns
This builder instance for method chaining.

Definition at line 68 of file ExtendedDeviceIdentificationBuilder.cs.

References WithEntry().


The documentation for this class was generated from the following file: