Class BluetoothAdapter

View Source

Definition

Namespace:
Tizen.Network.Bluetooth
Assembly:
Tizen.Network.Bluetooth.dll

This class is used to control the Bluetooth adapter and get the list of bonded devices.
The BluetoothAdapter class is used to discover neighbouring bluetooth devices.


                
C#

                

                    
Copy

                    

                

            
public static class BluetoothAdapter
Inheritance
object
BluetoothAdapter

Properties

View Source

Address

The local adapter address.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static string Address { get; }
Property Value
Type Description
string
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

IsBluetoothEnabled

A property to check whether the Bluetooth is enabled.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static bool IsBluetoothEnabled { get; }
Property Value
Type Description
bool
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

IsDiscoveryInProgress

A property to check whether the device discovery process is in progress.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static bool IsDiscoveryInProgress { get; }
Property Value
Type Description
bool
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

Name

The name of the local adapter.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static string Name { get; set; }
Property Value
Type Description
string
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

RemainingTimeAsVisible

The remaining time, in seconds, until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static int RemainingTimeAsVisible { get; }
Property Value
Type Description
int
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

Visibility

The visibility mode of the Bluetooth adapter.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static VisibilityMode Visibility { get; }
Property Value
Type Description
VisibilityMode
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.

Methods

View Source

CreateServerSocket(string)

Registers a rfcomm server socket with a specific UUID.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static BluetoothServerSocket CreateServerSocket(string serviceUuid)
Parameters
Type Name Description
string serviceUuid

The UUID of service to provide.
Returns
Type Description
BluetoothServerSocket

The BluetoothServerSocket instance.
Remarks

The Bluetooth must be enabled before calling this API.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or the socket create error occurs.
View Source

DestroyServerSocket(BluetoothServerSocket)

Removes the rfcomm server socket which was created using CreateServerSocket().

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("Deprecated since API level 6. Please use Dispose() on BluetoothServerSocket.")]
public static void DestroyServerSocket(BluetoothServerSocket socket)
Parameters
Type Name Description
BluetoothServerSocket socket

The server socket instance is created using CreateServerSocket().
Remarks

The socket must be created with CreateServerSocket(). The ConnectionStateChanged event is raised after this API is called.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or the socket destroy error occurs.
View Source

GetBluetoothLeAdvertiser()

Returns the BluetoothLeAdvertiser instance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static BluetoothLeAdvertiser GetBluetoothLeAdvertiser()
Returns
Type Description
BluetoothLeAdvertiser

The BluetoothLeAdvertiser instance.
Remarks

The Bluetooth must be enabled before calling this API.

View Source

GetBondedDevice(string)

Gets the device information of a bonded device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static BluetoothDevice GetBondedDevice(string address)
Parameters
Type Name Description
string address

The remote device address.
Returns
Type Description
BluetoothDevice

Information of the bonded BluetoothDeviceInfo object.
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or reading the bonded device information fails.
View Source

GetBondedDevices()

Retrieves the device information of all bonded devices.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static IEnumerable<BluetoothDevice> GetBondedDevices()
Returns
Type Description
System.Collections.Generic.IEnumerable<T><BluetoothDevice>

The list of the bonded BluetoothDeviceInfo objects.
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or reading the Bonded devices list is failed.
View Source

GetLocalOobData()

Gets the hash and the randomizer value of the local OOB data object.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static BluetoothOobData GetLocalOobData()
Returns
Type Description
BluetoothOobData

The BluetoothOobData object.
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or the read OObData procedure is failed.
View Source

IsServiceUsed(string)

Checks whether the UUID of service is used or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static bool IsServiceUsed(string serviceUuid)
Parameters
Type Name Description
string serviceUuid

The UUID of Service.
Returns
Type Description
bool

true if the specified serviceUuid is used, otherwise false.
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

RemoveRemoteOobData(string)

Removes the hash and the randomizer value of the OOB data from the remote device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void RemoveRemoteOobData(string address)
Parameters
Type Name Description
string address

The remote device address.
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled. or if the Remove Oobdata procedure is failed.
View Source

SetRemoteOobData(string, BluetoothOobData)

Sets the hash and the randmoizer value of the OOB data into the remote device.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetRemoteOobData(string address, BluetoothOobData oobData)
Parameters
Type Name Description
string address

The remote device address.
BluetoothOobData oobData

The BluetoothOobData object.
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or the set OobData procedure is failed.
View Source

StartDiscovery()

Starts the device discovery process.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void StartDiscovery()
Remarks

The Bluetooth must be enabled and the device discovery process can be stopped by StopDiscovery(). If this succeeds, the DiscoveryStateChanged event will be invoked.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or the start discovery fails.
View Source

StartLeScan()

Starts the Bluetooth LE scan operation to discover BLE devices

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void StartLeScan()
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth LE is not supported.
System.InvalidOperationException

Thrown when the Bluetooth LE is not enabled or the Start LE scan is failed.
View Source

StartLeScan(BluetoothLeScanMode)

Starts the Bluetooth LE scan operation with scan mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void StartLeScan(BluetoothLeScanMode mode)
Parameters
Type Name Description
BluetoothLeScanMode mode

The LE scan mode.
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth LE is not supported.
System.InvalidOperationException

Thrown when the Bluetooth LE is not enabled or the Start LE scan is failed.
View Source

StopDiscovery()

Stops the device discovery process.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void StopDiscovery()
Remarks

The device discovery process must be in progress with StartDiscovery(). If this succeeds, the DiscoveryStateChanged event will be invoked.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled or the discovery process is not is progress.
View Source

StopLeScan()

Stops the Bluetooth LE scan operation.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void StopLeScan()
Remarks

The Bluetooth must be enabled.

Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth LE is not supported.
System.InvalidOperationException

Thrown when the Bluetooth LE is not enabled or the Stop LE scan is failed.

Events

View Source

DiscoveryStateChanged

The DiscoveryStateChanged event is raised when the device discovery state is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<DiscoveryStateChangedEventArgs> DiscoveryStateChanged
Event Type
Type Description
System.EventHandler<TEventArgs><DiscoveryStateChangedEventArgs>
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

NameChanged

The NameChanged event is raised when the Bluetooth adapter name is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<NameChangedEventArgs> NameChanged
Event Type
Type Description
System.EventHandler<TEventArgs><NameChangedEventArgs>
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

ScanResultChanged

This event is called when the LE scan result is obtained.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<AdapterLeScanResultChangedEventArgs> ScanResultChanged
Event Type
Type Description
System.EventHandler<TEventArgs><AdapterLeScanResultChangedEventArgs>
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

StateChanged

The StateChanged event is raised when the Bluetooth adapter state is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<StateChangedEventArgs> StateChanged
Event Type
Type Description
System.EventHandler<TEventArgs><StateChangedEventArgs>
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

VisibilityDurationChanged

The VisibilityDurationChanged event is raised very second until the visibility mode is changed to NonDiscoverable.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<VisibilityDurationChangedEventArgs> VisibilityDurationChanged
Event Type
Type Description
System.EventHandler<TEventArgs><VisibilityDurationChangedEventArgs>
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.
View Source

VisibilityModeChanged

The VisibilityModeChanged event is raised when the Bluetooth adapter visibility mode is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event EventHandler<VisibilityModeChangedEventArgs> VisibilityModeChanged
Event Type
Type Description
System.EventHandler<TEventArgs><VisibilityModeChangedEventArgs>
Exceptions
Type Condition
System.NotSupportedException

Thrown when the Bluetooth is not supported.
System.InvalidOperationException

Thrown when the Bluetooth is not enabled.