smartlock::KeypadManager Interface Reference

Keypad Manager Interface. More...

import"KeypadManager.idl";

Classes
struct	KeypadSettings

Public Member Functions
vector< Keypad >	getKeypads ()
	Retrieve the list of connected keypads. More...
Keypad	getKeypadById (in string keypadId)
	Get keypad for a specific id. More...
int	setKeypadSettings (in string position, in KeypadSettings setting)
	Set settings for a keypad. More...
map< string, KeypadSettings >	getAllKeypadSettings ()
	Get settings for all keypads. More...

Public Attributes
valueobject	KeypadEvent: idl::Event { Keypad keypad
	Keypad base event. More...
Keypad::MetaData	metaData
	MetaData of affected keypad.
valueobject	KeypadAttachedEvent: KeypadEvent {}
	Keypad attached event.
valueobject	KeypadDetachedEvent: KeypadEvent {}
	Keypad detached event.
valueobject	KeypadSettingsChangedEvent: event::UserEvent { Keypad keypad
	affected keypad
KeypadSettings	oldSettings
	Settings before change.
KeypadSettings	newSettings
	Settings after change.
string	position
	Position of the keypad (see Keypad::MetaData)

Detailed Description

Keypad Manager Interface.

Member Function Documentation

getAllKeypadSettings()

map<string, KeypadSettings> smartlock::KeypadManager::getAllKeypadSettings

(

)

Get settings for all keypads.

Returns

Map of settings by keypad position (see Keypad::MetaData)

getKeypadById()

Keypad smartlock::KeypadManager::getKeypadById

(

in string

keypadId

)

Get keypad for a specific id.

Parameters

keypadId

keypad id

Returns

Keypad with given id or null

getKeypads()

vector<Keypad> smartlock::KeypadManager::getKeypads

(

)

Retrieve the list of connected keypads.

Returns

Keypads list

setKeypadSettings()

int smartlock::KeypadManager::setKeypadSettings	(	in string	position,
		in KeypadSettings	setting
	)

Set settings for a keypad.

Parameters

position	position of keypad (see Keypad::MetaData)
settings	new settings for keypad

Returns

NO_ERROR if OK

ERR_INVALID_PARAMS if any setting is invalid

Member Data Documentation

KeypadEvent

valueobject smartlock::KeypadManager::KeypadEvent

Keypad base event.

Affected keypad

---

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

• KeypadManager.idl