## NMDeviceBt

NMDeviceBt

## Synopsis

    enum                NMDeviceBtError;
    #define             NM_DEVICE_BT_ERROR
    GQuark              nm_device_bt_error_quark            (void);
    #define             NM_DEVICE_BT_HW_ADDRESS
    #define             NM_DEVICE_BT_NAME
    #define             NM_DEVICE_BT_CAPABILITIES
                        NMDeviceBt;
                        NMDeviceBtClass;
    GObject *           nm_device_bt_new                    (DBusGConnection *connection,
                                                             const char *path);
    const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
    const char *        nm_device_bt_get_name               (NMDeviceBt *device);
    NMBluetoothCapabilities nm_device_bt_get_capabilities   (NMDeviceBt *device);

## Object Hierarchy

      GObject
       +----NMObject
             +----NMDevice
                   +----NMDeviceBt

## Implemented Interfaces

NMDeviceBt implements GInitable and GAsyncInitable.

## Properties

      "bt-capabilities"          guint                 : Read
      "hw-address"               gchar*                : Read
      "name"                     gchar*                : Read

## Description

## Details

### enum NMDeviceBtError

    typedef enum {
    	NM_DEVICE_BT_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
    	NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION,     /*< nick=NotBtConnection >*/
    	NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION, /*< nick=InvalidBtConnection >*/
    	NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC,    /*< nick=InvalidDeviceMac >*/
    	NM_DEVICE_BT_ERROR_MAC_MISMATCH,          /*< nick=MacMismatch >*/
    	NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS,   /*< nick=MissingDeviceCaps >*/
    } NMDeviceBtError;

`NM_DEVICE_BT_ERROR_UNKNOWN` | unknown or unclassified error
`NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION` | the connection was not of bluetooth type
`NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION` | the bluetooth connection was invalid
`NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC` | the device's MAC was invalid
`NM_DEVICE_BT_ERROR_MAC_MISMATCH` | the MACs of the connection and the device mismatched
`NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS` | the device missed required capabilities

### NM_DEVICE_BT_ERROR

    #define NM_DEVICE_BT_ERROR nm_device_bt_error_quark ()

### nm_device_bt_error_quark ()

    GQuark              nm_device_bt_error_quark            (void);

Registers an error quark for NMDeviceBt if necessary.

Returns : | the error quark used for NMDeviceBt errors.

### NM_DEVICE_BT_HW_ADDRESS

    #define NM_DEVICE_BT_HW_ADDRESS   "hw-address"

### NM_DEVICE_BT_NAME

    #define NM_DEVICE_BT_NAME         "name"

### NM_DEVICE_BT_CAPABILITIES

    #define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"

### NMDeviceBt

    typedef struct _NMDeviceBt NMDeviceBt;

### NMDeviceBtClass

    typedef struct {
    	NMDeviceClass parent;

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    	void (*_reserved5) (void);
    	void (*_reserved6) (void);
    } NMDeviceBtClass;

### nm_device_bt_new ()

    GObject *           nm_device_bt_new                    (DBusGConnection *connection,
                                                             const char *path);

Creates a new NMDeviceBt.

`connection` : | the DBusGConnection
`path` : | the DBus object path of the device
Returns : | a new device. [transfer full]

### nm_device_bt_get_hw_address ()

    const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);

Gets the hardware (MAC) address of the NMDeviceBt

`device` : | a NMDeviceBt
Returns : | the hardware address. This is the internal string used by the device, and must not be modified.

### nm_device_bt_get_name ()

    const char *        nm_device_bt_get_name               (NMDeviceBt *device);

Gets the name of the NMDeviceBt.

`device` : | a NMDeviceBt
Returns : | the name of the device

### nm_device_bt_get_capabilities ()

    NMBluetoothCapabilities nm_device_bt_get_capabilities   (NMDeviceBt *device);

Returns the Bluetooth device's usable capabilities.

`device` : | a NMDeviceBt
Returns : | a combination of NMBluetoothCapabilities

## Property Details

### The `"bt-capabilities"` property

      "bt-capabilities"          guint                 : Read

The device's bluetooth capabilities, a combination of NMBluetoothCapabilities.

Default value: 0

### The `"hw-address"` property

      "hw-address"               gchar*                : Read

The hardware (MAC) address of the device.

Default value: NULL

### The `"name"` property

      "name"                     gchar*                : Read

The name of the bluetooth device.

Default value: NULL