dvblinkremote::SetParentalLockRequest Class Reference

Class for set parental lock requests. More...

Inheritance diagram for dvblinkremote::SetParentalLockRequest:

Public Member Functions
	SetParentalLockRequest (const std::string &clientId)
	Initializes a new instance of the dvblinkremote::SetParentalLockRequest class for disabling a parental lock.
	SetParentalLockRequest (const std::string &clientId, const std::string &code)
	Initializes a new instance of the dvblinkremote::SetParentalLockRequest class for enabling a parental lock.
	~SetParentalLockRequest ()
	Destructor for cleaning up allocated memory.
std::string &	GetClientID ()
	Gets the unique identification string of the client.
bool	IsEnabled ()
	Gets if the parental lock should be enabled or not for the set parental lock request.
std::string &	GetCode ()
	Gets the parental lock code for the set parental lock request.

Detailed Description

Class for set parental lock requests.

This is used as input parameter for the IDVBLinkRemoteConnection::SetParentalLock method.

See Also

IDVBLinkRemoteConnection::SetParentalLock()

Constructor & Destructor Documentation

dvblinkremote::SetParentalLockRequest::SetParentalLockRequest

(

const std::string &

clientId

)

Initializes a new instance of the dvblinkremote::SetParentalLockRequest class for disabling a parental lock.

Parameters

clientId

a constant string reference representing the unique identification string of the client.

Remarks

clientId should be the same across all DVBLink Client API calls from a given client. It can be a uuid for example or id/mac of the client device.

dvblinkremote::SetParentalLockRequest::SetParentalLockRequest	(	const std::string &	clientId,
		const std::string &	code
	)

Initializes a new instance of the dvblinkremote::SetParentalLockRequest class for enabling a parental lock.

Parameters

clientId	a constant string reference representing the unique identification string of the client.
code	a constant string reference representing the parental lock code.

Remarks

clientId should be the same across all DVBLink Client API calls from a given client. It can be a uuid for example or id/mac of the client device.

dvblinkremote::SetParentalLockRequest::~SetParentalLockRequest

(

)

Destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::SetParentalLockRequest::GetClientID

(

)

Gets the unique identification string of the client.

Returns

Client identifier

std::string& dvblinkremote::SetParentalLockRequest::GetCode

(

)

Gets the parental lock code for the set parental lock request.

Returns

Parental lock code

bool dvblinkremote::SetParentalLockRequest::IsEnabled

(

)

Gets if the parental lock should be enabled or not for the set parental lock request.

Returns

Enabled flag