Class BluetoothLeAdvertiseData

View Source

Definition

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

Bluetooth LE advertise data. Handles the data advertising.


                
C#

                

                    
Copy

                    

                

            
public class BluetoothLeAdvertiseData : IDisposable
Inheritance
object
BluetoothLeAdvertiseData
Implements
System.IDisposable

Constructors

View Source

BluetoothLeAdvertiseData()

The default constructor initializes an object of the BluetoothLeAdvertiseData.

Declaration

                
C#

                

                    
Copy

                    

                

            
public BluetoothLeAdvertiseData()
Exceptions
Type Condition
System.NotSupportedException

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

Thrown when the Bluetooth LE is not enabled or when create advertiser fails.

Properties

View Source

AdvertisingConnectable

The advertising connectable type.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool AdvertisingConnectable { get; set; }
Property Value
Type Description
bool
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 when the set advertising connectable mode fails.
View Source

AdvertisingMode

The advertising mode to control the advertising power and latency.

Declaration

                
C#

                

                    
Copy

                    

                

            
public BluetoothLeAdvertisingMode AdvertisingMode { get; set; }
Property Value
Type Description
BluetoothLeAdvertisingMode
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 when the set advertising mode fails.
View Source

Appearance

Sets the external appearance of this device to the advertise or the scan response data. Please refer to the adopted Bluetooth specification for the appearance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int Appearance { get; set; }
Property Value
Type Description
int
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 when the set appearance fails.
View Source

IncludeDeviceName

Sets whether the device name has to be included in the advertise or the scan response data. The maximum advertised or responded data size is 31 bytes including the data type and the system wide data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IncludeDeviceName { get; set; }
Property Value
Type Description
bool
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 when the set advertising device name fails.
View Source

IncludeTxPowerLevel

Sets whether the transmission power level should be included in the advertise or the scan response data. The maximum advertised or responded data size is 31 bytes including the data type and the system wide data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IncludeTxPowerLevel { get; set; }
Property Value
Type Description
bool
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 when the set advertising TC power level fails.
View Source

PacketType

The type of the packet.

Declaration

                
C#

                

                    
Copy

                    

                

            
public BluetoothLePacketType PacketType { get; set; }
Property Value
Type Description
BluetoothLePacketType

Methods

View Source

AddAdvertisingManufacturerData(BluetoothLePacketType, ManufacturerData)

Adds the manufacturer specific data to the advertise or the scan response data. Please refer to the adopted Bluetooth specification for the the appearance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AddAdvertisingManufacturerData(BluetoothLePacketType packetType, ManufacturerData manufacturerData)
Parameters
Type Name Description
BluetoothLePacketType packetType

The packet type.
ManufacturerData manufacturerData

The manufacturer specific data.
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 when the add advertising manufacturer data procedure fails.
View Source

AddAdvertisingServiceData(BluetoothLePacketType, BluetoothServiceData)

Adds a service data to the advertise or the scan response data. The maximum advertised or responded data size is 31 bytes including data type and system wide data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AddAdvertisingServiceData(BluetoothLePacketType packetType, BluetoothServiceData data)
Parameters
Type Name Description
BluetoothLePacketType packetType

The packet type.
BluetoothServiceData data

The service data to be added to advertising.
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 when the add advertising data procedure fails.
View Source

AddAdvertisingServiceSolicitationUuid(BluetoothLePacketType, string)

Adds a service solicitation UUID to advertise or scan the response data. The maximum advertised or responded data size is 31 bytes including the data type and the system wide data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AddAdvertisingServiceSolicitationUuid(BluetoothLePacketType packetType, string serviceSolicitationUuid)
Parameters
Type Name Description
BluetoothLePacketType packetType

The packet type.
string serviceSolicitationUuid

The service solicitation UUID to add to advertise data.
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 when the add advertising service solicitation UUID procedure fails.
View Source

AddAdvertisingServiceUuid(BluetoothLePacketType, string)

Adds a service UUID to the advertise or the scan response data. The maximum advertised or responded data size is 31 bytes including the data type and the system wide data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AddAdvertisingServiceUuid(BluetoothLePacketType packetType, string serviceUuid)
Parameters
Type Name Description
BluetoothLePacketType packetType

The packet type.
string serviceUuid

The service UUID to add to advertise data.
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 when the add advertising service UUID procedure fails.
View Source

Dispose()

Dispose

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
View Source

~BluetoothLeAdvertiseData()

BluetoothLeAdvertiseData destructor.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected ~BluetoothLeAdvertiseData()

Implements

System.IDisposable