• Api Documentation
  • Programmer's Guide
Show / Hide Table of Contents
  • rfid.api
    • ACCESS_OPERATION_CODE
    • ACCESS_OPERATION_STATUS
    • AccessFilter
    • AccessOperationResult
    • Actions
    • ALARM_LEVEL
    • ANTENNA_EVENT_TYPE
    • ANTENNA_MODE
    • ANTENNA_STOP_TRIGGER_TYPE
    • AntennaConfig
    • AntennaInfo
    • AntennaPortInfo
    • Antennas
    • Antennas.AntennaProperties
    • Antennas.AntennaRfConfig
    • Antennas.AntennaRfConfig.AntennaStopTrigger
    • Antennas.Config
    • Antennas.PhysicalProperties
    • Antennas.RFMode
    • Antennas.SingulationControl
    • Antennas.SingulationControl.SingulationAction
    • BATTERY_STATUS
    • BrandIDCheck
    • CABLE_LOSS_COMPENSATION
    • CableLossCompensation
    • CAPIEvents
    • CAPIEvents.RFSurveyReadNotifyHandler
    • chan_s
    • CHANNEL_TIMING
    • COMMUNICATION_STANDARD
    • COMMUNICATION_STANDARDS
    • CommunicationsStandardCode
    • CommunicationStandard
    • Config
    • COUNTRY_CODE
    • DISCONNECTION_EVENT_TYPE
    • DIVIDE_RATIO
    • Events
    • Events.AccessStartEventData
    • Events.AccessStopEventData
    • Events.AntennaEventData
    • Events.BufferFullWarningEventData
    • Events.DebugInfoEventData
    • Events.DisconnectionEventData
    • Events.GPIEventData
    • Events.HandheldTriggerEventData
    • Events.InventoryStartEventData
    • Events.InventoryStopEventData
    • Events.NXPEASAlarmEventData
    • Events.ReaderExceptionEventData
    • Events.ReadEventArgs
    • Events.ReadEventData
    • Events.ReadNotifyHandler
    • Events.RFSurvayStartEventData
    • Events.RFSurveyEventArgs
    • Events.RFSurveyEventData
    • Events.RFSurveyStopEventData
    • Events.STATUS_EVENT_TYPE
    • Events.StatusEventArgs
    • Events.StatusEventData
    • Events.StatusNotifyHandler
    • Events.TemperatureAlarmData
    • FILTER_ACTION
    • FORWARD_LINK_MODULATION
    • FrequencyHopInfo
    • FrequencyHopTable
    • Fujitsu
    • Fujitsu.AreaReadLockAccessParams
    • Fujitsu.AreaWriteLockAccessParams
    • Fujitsu.AreaWriteLockWOPasswordAccessParams
    • Fujitsu.BurstEraseAccessParams
    • Fujitsu.BurstWriteAccessParams
    • Fujitsu.ChangeBlockLockAccessParams
    • Fujitsu.ChangeBlockOrAreaGroupPasswordAccessParams
    • Fujitsu.ChangeWordLockAccessParams
    • Fujitsu.ReadBlockLockAccessParams
    • FujitsuBurstEraseResult
    • FujitsuBurstWriteResult
    • FujitsuReadBlockLockResult
    • FujitsuStats
    • GPI_PORT_STATE
    • GPIs
    • GPIs.GPI_PORT_STATE
    • GPIs.Port
    • GPITrigger
    • GPOs
    • GPOs.GPO_PORT_STATE
    • GPOs.Port
    • HANDHELD_TRIGGER_EVENT_TYPE
    • HandheldTrigger
    • HEALTH_STATUS
    • Impinj
    • Impinj.QTData
    • Impinj.QTReadAccessParams
    • Impinj.QTWriteAccessParams
    • ImpinjStats
    • InvalidUsageException
    • Inventory
    • INVENTORY_STATE
    • LED_COLOR
    • LedInfo
    • LLRPConnection
    • LLRPConnectionConfig
    • LocationInfo
    • LOCK_DATA_FIELD
    • LOCK_PRIVILEGE
    • LoginInfo
    • MATCH_PATTERN
    • MATCH_RANGE
    • MEMORY_BANK
    • MODULATION
    • NGE_REGUALTORY_CODE
    • NGE_Regulatory_Configuration
    • NGERegion
    • NgeRegionConfig
    • NXP
    • NXP.ChangeConfigParams
    • NXP.ChangeConfigResult
    • NXP.ReadProtectParams
    • NXP.ResetReadProtectParams
    • NXP.SetEASParams
    • NXPStats
    • OPERATION_QUALIFER
    • OperationFailureException
    • PerAntennaReceiveSensitivityRange
    • PeriodicTrigger
    • PixieEvents
    • PostFilter
    • POWER_NEGOTIATION_STATUS
    • POWER_SOURCE_TYPE
    • PreFilters
    • PreFilters.PreFilter
    • PreFilters.StateAwareActionParams
    • PreFilters.StateUnawareAction
    • Profile
    • RADIO_POWER_STATE
    • RadioConfigUpdate
    • RadioFirmwareUpdate
    • READER_EXCEPTION_EVENT_TYPE
    • READER_ID_TYPE
    • READER_TYPE
    • ReaderCapabilities
    • ReaderCapabilities.ReaderIdentification
    • ReaderInfo
    • ReaderManagement
    • ReaderMinorState
    • ReaderModuleVersion
    • ReaderOperation
    • ReaderRegion
    • ReaderRegion.ActiveRegionInfo
    • ReaderRegion.CommunicationStandardInfo
    • ReaderState
    • ReaderStatistics
    • ReaderType
    • ReadPoint
    • READPOINT_STATUS
    • RECOMMISSION_OPERATION_CODE
    • REG_REGION_DOMAIN
    • REGION_CODE
    • REGION_CONFIG_DATA
    • RegionConfig
    • regLBT
    • regOnOff
    • REGULATORY_CONFIG_DATA
    • REGULATORY_LINKPROFILE_DATA
    • ReportTriggers
    • RFID_EVENT_TYPE
    • RFID_SKU
    • RfidApi4Abstract
    • RfidGlobalData
    • RFIDReader
    • RFIDResults
    • RFIDTransportType
    • RFModes
    • RFModeTable
    • RFModeTableEntry
    • RFSurvey
    • RFSURVEY_EVENT_REPORT_TRIGGER
    • RFSurveyData
    • RFSurveyEventReportInfo
    • RssiRangeFilter
    • SECURE_MODE
    • SecureConnectionInfo
    • SecureModeConfig
    • SeenTime
    • SERVICE_ID
    • SESSION
    • SL_FLAG
    • SoftwareUpdate
    • SoftwareUpdateInfo
    • SPECTRAL_MASK_INDICATOR
    • STANDARD_INFO_LISTW
    • STANDARD_REGION_INFOW
    • START_TRIGGER_TYPE
    • StartTrigger
    • STATE_AWARE_ACTION
    • STATE_UNAWARE_ACTION
    • STOP_TRIGGER_TYPE
    • StopTrigger
    • SUPPORTED_BAUDRATE
    • SystemInfo
    • TAG_EVENT
    • TAG_EVENT_REPORT_TRIGGER
    • TAG_FIELD
    • TagAccess
    • TagAccess.BlockEraseAccessParams
    • TagAccess.BlockPermalockAccessParams
    • TagAccess.KillAccessParams
    • TagAccess.LockAccessParams
    • TagAccess.ReadAccessParams
    • TagAccess.RecommisionAccessParams
    • TagAccess.Sequence
    • TagAccess.Sequence.Operation
    • TagAccess.WriteAccessParams
    • TagAccess.WriteSpecificFieldAccessParams
    • TagData
    • TagEventReportInfo
    • TagLocationing
    • TagPatternBase
    • TagStorageSettings
    • TagZoneInfo
    • TARGET
    • TEMPERATURE_SOURCE
    • TemperatureStatus
    • TimeZone
    • TRACE_LEVEL
    • TriggerInfo
    • TriggerWithTimeout
    • TRUNCATE_ACTION
    • UpdateStatus
    • UpTime
    • USB_OPERATION_MODE
    • USBOperationMode
    • UserApp
    • UserAppInfo
    • UserInfo
    • UTCTime
    • VersionInfo
    • WRITE_FIELD_CODE
    • Zones
    • Zones.ZoneConfig
    • ZoneSequence
    • ZoneSequence.ZoneInfo

Class CAPIEvents

This class represents the events supported. The events are signalled ony when it is enabled. The properties allows to enable required events.

Inheritance
System.Object
Events
CAPIEvents
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: rfid.api
Assembly: rfid.netcore.dll
Syntax
public class CAPIEvents : Events

Properties

AttachRFSurveyDataWithReadEvent

Specified whether RF Survey should be reported along with the RFSurveyReadNotify Event Handler

Declaration
public override bool AttachRFSurveyDataWithReadEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.AttachRFSurveyDataWithReadEvent

AttachTagDataWithReadEvent

Specified whether TagData should be reported along with the ReadNotify Event Handler

Declaration
public override bool AttachTagDataWithReadEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.AttachTagDataWithReadEvent

HostName

Host name or IP Address of the reader

Declaration
public override string HostName { get; }
Property Value
Type Description
System.String
Overrides
Events.HostName

NotifyAccessStartEvent

To enable/disable Access Start Event Notification.

Declaration
public override bool NotifyAccessStartEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyAccessStartEvent

NotifyAccessStopEvent

To enable/disable Access Stop Event Notification.

Declaration
public override bool NotifyAccessStopEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyAccessStopEvent

NotifyAntennaEvent

To enable/disable Antenna Event Notification. This event is generated when the Reader detects that an antenna is connected or disconnected

Declaration
public override bool NotifyAntennaEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyAntennaEvent

NotifyBufferFullEvent

To enable/disbale Buffer full Event Notification. When the internal buffers are 100% full, BUFFER_FULL_EVENT will be notified every time a new tag report is received.The oldest TagData reports will be replaced by the newest in a circular FIFO manner.

Declaration
public override bool NotifyBufferFullEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyBufferFullEvent

NotifyBufferFullWarningEvent

To enable/disable Buffer full warning Event Notification. When the internal buffers are 90% full, BUFFER_FULL_WARNING_EVENT will be notified. When the buffers are 100% full, no more Tags can be stored in Dll or in the Reader, and further tags are discarded.

Declaration
public override bool NotifyBufferFullWarningEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyBufferFullWarningEvent

NotifyDebugInfoEvent

To enable/disable DEBUG_INFO_EVENT Notification

Declaration
public override bool NotifyDebugInfoEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyDebugInfoEvent

NotifyEASAlarmEvent

To enable/disable NXP_EAS_ALARM_EVENT Notification

Declaration
public override bool NotifyEASAlarmEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyEASAlarmEvent

NotifyGPIEvent

To enable/disable GPI Event Notification. GPI_EVENT will be signaled every time an enabled GPI changes state.

Declaration
public override bool NotifyGPIEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyGPIEvent

NotifyHandheldTriggerEvent

To enable/disable GPI Event Notification. GPI_EVENT will be signaled every time an enabled GPI changes state.

Declaration
public override bool NotifyHandheldTriggerEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyHandheldTriggerEvent

NotifyInventoryStartEvent

To enable/disable Inventory Start Event Notification.

Declaration
public override bool NotifyInventoryStartEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyInventoryStartEvent

NotifyInventoryStopEvent

To enable/disable Inventory Stop Event Notification.

Declaration
public override bool NotifyInventoryStopEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyInventoryStopEvent

NotifyReaderDisconnectEvent

To enable/disable Reader Disconnection Event Notification. The Application can call Reconnect() to manually reconnect to the Reader Or opt for auto-reconnection. To cleanup and exit the application can call Disconnect().

Declaration
public override bool NotifyReaderDisconnectEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyReaderDisconnectEvent

NotifyReaderExceptionEvent

To enable/disable Reader Exception Event Notification. The Application can continue to use the connection if the reader renders is usable.

Declaration
public override bool NotifyReaderExceptionEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyReaderExceptionEvent

NotifyRFSurveyStartEvent

To enable/disable RF Survey Start Event Notification.

Declaration
public override bool NotifyRFSurveyStartEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyRFSurveyStartEvent

NotifyRFSurveyStopEvent

To enable/disable RFSurvey Stop Event Notification.

Declaration
public override bool NotifyRFSurveyStopEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyRFSurveyStopEvent

NotifyTemperatureAlarmEvent

To enable/disable Temperature Alarm Event Notification.

Declaration
public override bool NotifyTemperatureAlarmEvent { get; set; }
Property Value
Type Description
System.Boolean
Overrides
Events.NotifyTemperatureAlarmEvent

Methods

Finalize()

Destructor

Declaration
protected void Finalize()

Events

ReadNotify

Notifies the Tag Read Notification.

Declaration
public override event Events.ReadNotifyHandler ReadNotify
Event Type
Type Description
Events.ReadNotifyHandler
Overrides
Events.ReadNotify

StatusNotify

Notifies the status change notification

Declaration
public override event Events.StatusNotifyHandler StatusNotify
Event Type
Type Description
Events.StatusNotifyHandler
Overrides
Events.StatusNotify
Back to top