Raritan PX2/PX3 JSON-RPC API
Classes | Public Member Functions | Public Attributes | List of all members
smartcard::CardReaderManager_1_0_3 Interface Reference

Card Reader Manager Interface. More...

import"CardReaderManager.idl";

Classes

struct  CardReaderSettings
 Card Reader Settings. More...
 

Public Member Functions

vector< CardReader_1_0_3getCardReaders ()
 Retrieve the list of connected card readers. More...
 
CardReader_1_0_3 getCardReaderById (in string readerId)
 Get card reader for a specific id. More...
 
int setCardReaderSettings (in string position, in CardReaderSettings setting)
 Set settings for a card reader. More...
 
map< string, CardReaderSettingsgetAllCardReaderSettings ()
 Get settings for all card readers. More...
 

Public Attributes

valueobject CardReaderEvent: idl::Event { CardReader_1_0_3 cardReader
 Card Reader base event. More...
 
valueobject CardReaderAttachedEvent: CardReaderEvent {}
 Card Reader attached event.
 
valueobject CardReaderDetachedEvent: CardReaderEvent {}
 Card Reader detached event.
 
valueobject CardReaderSettingsChangedEvent: event::UserEvent { CardReaderSettings oldSettings
 Settings before change.
 
CardReaderSettings newSettings
 Settings after change.
 
string position
 Position of the card reader (see CardReader::MetaData)
 

Detailed Description

Card Reader Manager Interface.

Member Function Documentation

◆ getAllCardReaderSettings()

map<string, CardReaderSettings> smartcard::CardReaderManager_1_0_3::getAllCardReaderSettings ( )

Get settings for all card readers.

Returns
Map of settings by card reader position (see CardReader::MetaData)

◆ getCardReaderById()

CardReader_1_0_3 smartcard::CardReaderManager_1_0_3::getCardReaderById ( in string  readerId)

Get card reader for a specific id.

Parameters
readerIdcard reader id
Returns
Card Reader with given id or null

◆ getCardReaders()

vector<CardReader_1_0_3> smartcard::CardReaderManager_1_0_3::getCardReaders ( )

Retrieve the list of connected card readers.

Returns
Card Readers list

◆ setCardReaderSettings()

int smartcard::CardReaderManager_1_0_3::setCardReaderSettings ( in string  position,
in CardReaderSettings  setting 
)

Set settings for a card reader.

Parameters
positionposition of card reader (see CardReader::MetaData)
settingsnew settings for card reader
Returns
NO_ERROR if OK
ERR_INVALID_PARAMS if any setting is invalid

Member Data Documentation

◆ CardReaderEvent

valueobject smartcard::CardReaderManager_1_0_3::CardReaderEvent

Card Reader base event.

affected card reader


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