smartcard::CardReaderManager Interface Reference

Card Reader Manager Interface. More...

import"CardReaderManager.idl";

Classes
struct	CardReaderSettings
	Card Reader Settings. More...

Public Member Functions
vector< CardReader >	getCardReaders ()
	Retrieve the list of connected card readers. More...
CardReader	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, CardReaderSettings >	getAllCardReaderSettings ()
	Get settings for all card readers. More...
vector< string >	getSupportedCardFormats ()
	Retrieve the list of supported card formats like "RAW", "H10301", etc. More...

Public Attributes
valueobject	CardReaderEvent: idl::Event { CardReader cardReader
	Card Reader base event. More...
CardReader::MetaData	metaData
	Metadata of affected card reader.
valueobject	CardReaderAttachedEvent: CardReaderEvent {}
	Card Reader attached event.
valueobject	CardReaderDetachedEvent: CardReaderEvent {}
	Card Reader detached event.
valueobject	CardReaderSettingsChangedEvent: event::UserEvent { CardReader cardReader
	affected card reader
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::getAllCardReaderSettings

(

)

Get settings for all card readers.

Returns

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

getCardReaderById()

CardReader smartcard::CardReaderManager::getCardReaderById

(

in string

readerId

)

Get card reader for a specific id.

Parameters

readerId

card reader id

Returns

Card Reader with given id or null

getCardReaders()

vector<CardReader> smartcard::CardReaderManager::getCardReaders

(

)

Retrieve the list of connected card readers.

Returns

Card Readers list

getSupportedCardFormats()

vector<string> smartcard::CardReaderManager::getSupportedCardFormats

(

)

Retrieve the list of supported card formats like "RAW", "H10301", etc.

Returns

Card Formats list

setCardReaderSettings()

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

Set settings for a card reader.

Parameters

position	position of card reader (see CardReader::MetaData)
settings	new settings for card reader

Returns

NO_ERROR if OK

ERR_INVALID_PARAMS if any setting is invalid

Note

The CardReaderSettings structure can be "sparse"; fields missing in the JSON representation will remain unchanged.

Member Data Documentation

CardReaderEvent

valueobject smartcard::CardReaderManager::CardReaderEvent

Card Reader base event.

Affected card reader

---

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

• CardReaderManager.idl