alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy Class Reference

#include <DBusPropertiesProxy.h>

Inheritance diagram for alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy:

Collaboration diagram for alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy:

Public Member Functions
bool	getBooleanProperty (const std::string &interface, const std::string &property, bool *result)
bool	getStringProperty (const std::string &interface, const std::string &property, std::string *result)
bool	getVariantProperty (const std::string &interface, const std::string &property, ManagedGVariant *result)
bool	setProperty (const std::string &interface, const std::string &property, GVariant *value)
Public Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy
virtual	~DBusProxy ()
virtual ManagedGVariant	callMethod (const std::string &methodName, GVariant *parameters=nullptr, GError **error=nullptr)
virtual ManagedGVariant	callMethodWithFDList (const std::string &methodName, GVariant *parameters=nullptr, GUnixFDList **outlist=nullptr, GError **error=nullptr)
virtual std::string	getObjectPath () const
virtual GDBusProxy *	get ()

Static Public Member Functions
static std::shared_ptr< DBusPropertiesProxy >	create (const std::string &objectPath)
Static Public Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy
static std::shared_ptr< DBusProxy >	create (const std::string &interfaceName, const std::string &objectPath)

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::bluetoothImplementations::blueZ::DBusProxy
	DBusProxy (GDBusProxy *proxy, const std::string &objectPath)

Detailed Description

A special case of DBus proxy that binds to properties of a specific object

See GVariant Format Strings for type strings explanation.

Member Function Documentation

create()

static std::shared_ptr<DBusPropertiesProxy> alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy::create ( const std::string &  objectPath )

static

A factory method to create a new instance

Parameters

objectPath

Returns

New instance of DBusPropertiesProxy on success, nullptr otherwise.

getBooleanProperty()

bool alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy::getBooleanProperty	(	const std::string &	interface,
		const std::string &	property,
		bool *	result
	)

Get value of the interface's boolean property

Parameters

	interface	Name of the interface to query
	property	Name of the property to get
[out]	result	A pointer to a bool variable that receives the property value

Returns

true if property was found, false otherwise.

getStringProperty()

bool alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy::getStringProperty	(	const std::string &	interface,
		const std::string &	property,
		std::string *	result
	)

Get value of the interface's string property

Parameters

	interface	Name of the interface to query
	property	Name of the property to get
[out]	result	A reference a to std::string variable that receives the property value

Returns

true if property was found, false otherwise.

getVariantProperty()

bool alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy::getVariantProperty	(	const std::string &	interface,
		const std::string &	property,
		ManagedGVariant *	result
	)

Get value of the interface's variant property

Parameters

	interface	Name of the interface to query
	property	Name of the property to get
[out]	result	A reference to ManagedGVariant variable that receives the property value

Returns

true if property was found, false otherwise.

setProperty()

bool alexaClientSDK::bluetoothImplementations::blueZ::DBusPropertiesProxy::setProperty	(	const std::string &	interface,
		const std::string &	property,
		GVariant *	value
	)

Set value of the interface's property

Parameters

interface	Name of the interface owning the property
property	Name of the property to set
value	A @ GVariant* value to set

Returns

true if property was found and its value has been changed, false otherwise.

---

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

• /workplace/avs-device-sdk/BluetoothImplementations/BlueZ/include/BlueZ/DBusPropertiesProxy.h