user_credential::user_capabilities Class Reference

#include <user_credential_user_capabilities.h>

Collaboration diagram for user_credential::user_capabilities:

Public Member Functions
	user_capabilities (attribute_store::attribute endpoint_node)
	~user_capabilities ()=default
bool	is_user_valid (user_credential_user_unique_id_t user_id, user_credential_type_t user_type, user_credential_rule_t credential_rule, const char *user_name) const
	Check if the user proprieties are valid. More...
bool	is_user_name_valid (const char *user_name) const
	Checks if the given user name is valid. More...
bool	is_user_id_valid (user_credential_user_unique_id_t user_id) const
	Check if a user id is valid. More...
bool	is_user_type_supported (user_credential_type_t user_type) const
	Check if a user type is supported. More...
bool	is_credential_rule_supported (user_credential_rule_t credential_rule) const
	Check if a credential rule is supported. More...
bool	is_all_users_checksum_supported () const
	Check if all users checksum is supported. More...
bool	is_user_checksum_supported () const
	Check if user checksum is supported. More...
bool	is_user_schedule_supported () const
	Check if user schedule is supported. More...

Private Attributes
uint16_t	max_user_count = 0
uint8_t	supported_credential_rules_bitmask = 0
uint32_t	supported_user_types_bitmask = 0
uint8_t	max_user_name_length = 0
uint8_t	support_user_schedule = 0
uint8_t	support_all_users_checksum = 0
uint8_t	support_by_user_checksum = 0
bool	is_data_valid = false

Constructor & Destructor Documentation

user_capabilities()

user_credential::user_capabilities::user_capabilities ( attribute_store::attribute  endpoint_node )

explicit

~user_capabilities()

user_credential::user_capabilities::~user_capabilities ( )

default

Member Function Documentation

is_all_users_checksum_supported()

bool user_credential::user_capabilities::is_all_users_checksum_supported

(

)

const

Check if all users checksum is supported.

Returns

true All users checksum is supported

false All users checksum is not supported

is_credential_rule_supported()

bool user_credential::user_capabilities::is_credential_rule_supported

(

user_credential_rule_t

credential_rule

)

const

Check if a credential rule is supported.

Parameters

credential_rule

Credential rule to check

Returns

true Credential rule is supported

false Credential rule is not supported

is_user_checksum_supported()

bool user_credential::user_capabilities::is_user_checksum_supported

(

)

const

Check if user checksum is supported.

Returns

true User checksum is supported

false User checksum is not supported

is_user_id_valid()

bool user_credential::user_capabilities::is_user_id_valid

(

user_credential_user_unique_id_t

user_id

)

const

Check if a user id is valid.

Parameters

user_id

User ID to check

Returns

true User ID is valid

false User ID is not valid

is_user_name_valid()

bool user_credential::user_capabilities::is_user_name_valid

(

const char *

user_name

)

const

Checks if the given user name is valid.

Parameters

user_name

The user name to be validated.

Returns

true User name is valid

false User name is not valid

is_user_schedule_supported()

bool user_credential::user_capabilities::is_user_schedule_supported

(

)

const

Check if user schedule is supported.

Returns

true User schedule is supported

false User schedule is not supported

is_user_type_supported()

bool user_credential::user_capabilities::is_user_type_supported

(

user_credential_type_t

user_type

)

const

Check if a user type is supported.

Parameters

user_type

User type to check

Returns

true User type is supported

false User type is not supported

is_user_valid()

bool user_credential::user_capabilities::is_user_valid	(	user_credential_user_unique_id_t	user_id,
		user_credential_type_t	user_type,
		user_credential_rule_t	credential_rule,
		const char *	user_name
	)		const

Check if the user proprieties are valid.

Note

Will return false if is_data_valid is false

Parameters

user_id	User ID
user_type	User type
credential_rule	Credential rule
user_name	User name

Returns

true User is valid

false User is not valid

Member Data Documentation

is_data_valid

bool user_credential::user_capabilities::is_data_valid = false

private

max_user_count

uint16_t user_credential::user_capabilities::max_user_count = 0

private

max_user_name_length

uint8_t user_credential::user_capabilities::max_user_name_length = 0

private

support_all_users_checksum

uint8_t user_credential::user_capabilities::support_all_users_checksum = 0

private

support_by_user_checksum

uint8_t user_credential::user_capabilities::support_by_user_checksum = 0

private

support_user_schedule

uint8_t user_credential::user_capabilities::support_user_schedule = 0

private

supported_credential_rules_bitmask

uint8_t user_credential::user_capabilities::supported_credential_rules_bitmask = 0

private

supported_user_types_bitmask

uint32_t user_credential::user_capabilities::supported_user_types_bitmask = 0

private

---

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

• applications/zpc/components/zwave_command_classes/src/private/user_credential/user_credential_user_capabilities.h