namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// A class which is used to control a bluetooth adapter and get the list of bonded devices.<br>
+ /// This class is used to control the Bluetooth adapter and get the list of bonded devices.<br>
/// The BluetoothAdapter class is used to discover neighbouring bluetooth devices.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
static public class BluetoothAdapter
{
/// <summary>
- /// A property to check whether Bluetooth is enabled.
+ /// A property to check whether the Bluetooth is enabled.
/// </summary>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public bool IsBluetoothEnabled
{
get
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public string Address
{
get
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public string Name
{
get
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public VisibilityMode Visibility
{
get
}
/// <summary>
- /// A property to check whether device discovery is in progress.
+ /// A property to check whether the device discovery process is in progress.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public bool IsDiscoveryInProgress
{
get
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public int RemainingTimeAsVisible
{
get
}
/// <summary>
- /// (event) StateChanged is raised when bluetooth adapter state is changed.
+ /// The StateChanged event is raised when the Bluetooth adapter state is changed.
/// </summary>
static public event EventHandler<StateChangedEventArgs> StateChanged
{
}
/// <summary>
- /// (event) NameChanged is raised when bluetooth adapter name is changed.
+ /// The NameChanged event is raised when the Bluetooth adapter name is changed.
/// </summary>
static public event EventHandler<NameChangedEventArgs> NameChanged
{
}
/// <summary>
- /// (event) VisibilityModeChanged is raised when bluetooth adapter visibility mode is changed.
+ /// The VisibilityModeChanged event is raised when the Bluetooth adapter visibility mode is changed.
/// </summary>
static public event EventHandler<VisibilityModeChangedEventArgs> VisibilityModeChanged
{
}
/// <summary>
- /// (event) VisibilityDurationChanged is raised very second until the visibility mode is changed to NonDiscoverable.
+ /// The VisibilityDurationChanged event is raised very second until the visibility mode is changed to NonDiscoverable.
/// </summary>
static public event EventHandler<VisibilityDurationChangedEventArgs> VisibilityDurationChanged
{
}
/// <summary>
- /// (event) DiscoveryStateChanged is raised when the device discovery state is changed.
+ /// The DiscoveryStateChanged event is raised when the device discovery state is changed.
/// </summary>
static public event EventHandler<DiscoveryStateChangedEventArgs> DiscoveryStateChanged
{
}
/// <summary>
- /// Event that is called when the LE Scan result is obtained.
+ /// This event is called when the LE scan result is obtained.
/// </summary>
static public event EventHandler<AdapterLeScanResultChangedEventArgs> ScanResultChanged
{
/// Starts the device discovery process.
/// </summary>
/// <remarks>
- /// The Bluetooth must be enabled and device discovery can be stopped by StopDiscovery().
- /// If this succeeds, DiscoveryStateChanged event will be invoked.
+ /// The Bluetooth must be enabled and the device discovery process can be stopped by StopDiscovery().
+ /// If this succeeds, the DiscoveryStateChanged event will be invoked.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or the start discovery fails.</exception>
static public void StartDiscovery()
{
/// Stops the device discovery process.
/// </summary>
/// <remarks>
- /// The device discovery must be in progress with StartDiscovery().
- /// If this succeeds, DiscoveryStateChanged event will be invoked.
+ /// The device discovery process must be in progress with StartDiscovery().
+ /// If this succeeds, the DiscoveryStateChanged event will be invoked.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// the Discovery is not is prpgress </exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled or
+ /// the discovery process is not is progress. </exception>
static public void StopDiscovery()
{
if (IsDiscoveryInProgress)
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <returns> List of Bonded BluetoothDeviceInfo objects.</returns>
+ /// <returns> The list of the bonded BluetoothDeviceInfo objects.</returns>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or reading the Bonded devices list is failed.</exception>
static public IEnumerable<BluetoothDevice> GetBondedDevices()
{
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <returns> Information of bonded BluetoothDeviceInfo object.</returns>
+ /// <returns> Information of the bonded BluetoothDeviceInfo object.</returns>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or reading the bonded device information fails.</exception>
static public BluetoothDevice GetBondedDevice(string address)
{
/// <summary>
/// Checks whether the UUID of service is used or not.
/// </summary>
- /// <returns><c>true</c> if the specified serviceUuid is used; otherwise, <c>false</c>.</returns>
+ /// <returns><c>true</c> if the specified serviceUuid is used, otherwise <c>false</c>.</returns>
/// <param name="serviceUuid">The UUID of Service.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public bool IsServiceUsed(string serviceUuid)
{
return BluetoothAdapterImpl.Instance.IsServiceUsed(serviceUuid);
}
/// <summary>
- /// Gets the hash and randomizer value of local oob data object.
+ /// Gets the hash and the randomizer value of the local OOB data object.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <returns>The BluetoothOobData object.</returns>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or the read OObData procedure is failed</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or the read OObData procedure is failed.</exception>
static public BluetoothOobData GetLocalOobData()
{
if (IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Sets the Hash and Randmoizer value of oob data into the remote device.
+ /// Sets the hash and the randmoizer value of the OOB data into the remote device.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="address">Remote Device address.</param>
- /// <param name="oobData">BluetoothOobData object.</param>
+ /// <param name="address">The remote device address.</param>
+ /// <param name="oobData">The BluetoothOobData object.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or the set Oobdata procedure is failed.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or the set OobData procedure is failed.</exception>
static public void SetRemoteOobData(string address, BluetoothOobData oobData)
{
if (IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Removes the Hash and Randomizer value of oob data from the remote device.
+ /// Removes the hash and the randomizer value of the OOB data from the remote device.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="address">Remote Device address.</param>
+ /// <param name="address">The remote device address.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled.
/// or if the Remove Oobdata procedure is failed.</exception>
static public void RemoveRemoteOobData(string address)
{
}
/// <summary>
- /// Starts the Bluetooth Le scan operation to discover BLE devices
+ /// Starts the Bluetooth LE scan operation to discover BLE devices
/// </summary>
/// <remarks>
- /// Bluetooth must be enabled.
- /// </remarks>the result of the operation StartLeScan
+ /// The Bluetooth must be enabled.
+ /// </remarks>The result of the operation StartLeScan.
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or the Start LE Scan is failed.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or the Start LE scan is failed.</exception>
static public void StartLeScan()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Stops the Bluetooth Le scan operation.
+ /// Stops the Bluetooth LE scan operation.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
- /// </remarks>the result of the operation stopLescan
+ /// </remarks>The result of the operation stopLescan.
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or Stop LE Scan is failed.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or the Stop LE scan is failed.</exception>
static public void StopLeScan()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Returns BluetoothLeAdvertiser instance.
+ /// Returns the BluetoothLeAdvertiser instance.
/// </summary>
/// <remarks>
- /// The bluetooth must be enabled before calling this API.
+ /// The Bluetooth must be enabled before calling this API.
/// </remarks>
/// <returns>The BluetoothLeAdvertiser instance.</returns>
static public BluetoothLeAdvertiser GetBluetoothLeAdvertiser()
/// Registers a rfcomm server socket with a specific UUID.
/// </summary>
/// <remarks>
- /// The bluetooth must be enabled before calling this API.
+ /// The Bluetooth must be enabled before calling this API.
/// </remarks>
/// <returns>The BluetoothServerSocket instance.</returns>
/// <param name="serviceUuid">The UUID of service to provide.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or Socket create error happens.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or the socket create error occurs.</exception>
static public BluetoothServerSocket CreateServerSocket(string serviceUuid)
{
if (IsBluetoothEnabled && Globals.IsInitialize)
/// Removes the rfcomm server socket which was created using CreateServerSocket().
/// </summary>
/// <remarks>
- /// The socket must be created with CreateServerSocket(). ConnectionStateChanged event is raised after this API is called.
+ /// The socket must be created with CreateServerSocket(). The ConnectionStateChanged event is raised after this API is called.
/// </remarks>
- /// <param name="socket">The server socket instance which is created using CreateServerSocket().</param>
+ /// <param name="socket">The server socket instance is created using CreateServerSocket().</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or socket destroy error happens.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or the socket destroy error occurs.</exception>
static public void DestroyServerSocket(BluetoothServerSocket socket)
{
if (IsBluetoothEnabled && Globals.IsInitialize)
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// A class which is used to handle the connection with other Bluetooth audio devices
- /// like headset, hands-free and headphone.
+ /// This class is used to handle the connection with other Bluetooth audio devices
+ /// like headset, hands-free, and headphone.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
public class BluetoothAudio : BluetoothProfile
}
/// <summary>
- /// (event) AudioConnectionStateChanged is called when audio connection state is changed.
+ /// The AudioConnectionStateChanged event is called when the audio connection state is changed.
/// </summary>
public event EventHandler<AudioConnectionStateChangedEventArgs> AudioConnectionStateChanged
{
}
/// <summary>
- /// Connect the remote device with the given audio profile.
+ /// Connects the remote device with the given audio profile.
/// </summary>
/// <remarks>
- /// The device must be bonded with remote device by CreateBond().If connection request succeeds, AudioConnectionStateChanged event will be invoked.
- /// If audio profile type is All and this request succeeds, then AudioConnectionStateChanged event will be called twice when HspHfp <br>
+ /// The device must be bonded with the remote device by CreateBond(). If connection request succeeds, the AudioConnectionStateChanged event will be invoked.
+ /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp <br>
/// and AdvancedAudioDistribution is connected.
/// </remarks>
- /// <param name="profileType">Type of audio profile.</param>
+ /// <param name="profileType">The type of the audio profile.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the connection attempt fails.</exception>
public void Connect(BluetoothAudioProfileType profileType)
{
/// Disconnects the remote device with the given audio profile.
/// </summary>
/// <remarks>
- /// The device must be connected by Connect().If the disconnection request succeeds, AudioConnectionStateChanged event will be invoked.
- /// If audio profile type is All and this request succeeds, then AudioConnectionStateChanged event will be called twice when HspHfp <br>
+ /// The device must be connected by Connect(). If the disconnection request succeeds, the AudioConnectionStateChanged event will be invoked.
+ /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp <br>
/// and AdvancedAudioDistribution is disconnected.
/// </remarks>
- /// <param name="type">Type of audio profile.</param>
+ /// <param name="type">The type of the audio profile.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when Disconnection attempt fails.</exception>
public void Disconnect(BluetoothAudioProfileType type)
{
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// A class which is used to notify changes of the target device(e.g.media player) to the control device(e.g.headset).
+ /// This class is used to notify changes of the target device (For example, media player) to the control device (For example, headset).
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
public class BluetoothAvrcp : BluetoothProfile
}
/// <summary>
- /// (event) TargetConnectionStateChanged is invoked when the connection state is changed.
+ /// The TargetConnectionStateChanged event is invoked when the connection state is changed.
/// </summary>
public event EventHandler<TargetConnectionStateChangedEventArgs> TargetConnectionStateChanged
{
}
/// <summary>
- /// (event) EqualizerStateChanged is invoked when the equalizer state is changed by the remote control device.
+ /// The EqualizerStateChanged event is invoked when the equalizer state is changed by the remote control device.
/// </summary>
public event EventHandler<EqualizerStateChangedEventArgs> EqualizerStateChanged
{
}
/// <summary>
- /// (event) RepeatModeChanged is invoked when the repeat mode is changed by the remote control device.
+ /// The RepeatModeChanged event is invoked when the repeat mode is changed by the remote control device.
/// </summary>
public event EventHandler<RepeatModeChangedEventArgs> RepeatModeChanged
{
}
/// <summary>
- /// (event) ShuffleModeChanged is invoked when the shuffle mode is changed by the remote control device.
+ /// The ShuffleModeChanged event is invoked when the shuffle mode is changed by the remote control device.
/// </summary>
public event EventHandler<ShuffleModeChangedeventArgs> ShuffleModeChanged
{
}
/// <summary>
- /// (event) ScanModeChanged is invoked when the scan mode is changed by the remote control device.
+ /// The ScanModeChanged event is invoked when the scan mode is changed by the remote control device.
/// </summary>
public event EventHandler<ScanModeChangedEventArgs> ScanModeChanged
{
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="state">Equalizer state.</param>
+ /// <param name="state">The equalizer state.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the equalizer state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the equalizer state to the remote device fails.</exception>
public void NotifyEqualizerState(EqualizerState state)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="mode">Repeat mode.</param>
+ /// <param name="mode">The repeat mode.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the repeat mode state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the repeat mode state to the remote device fails.</exception>
/// </exception>
public void NotifyRepeatMode(RepeatMode mode)
{
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="mode">Shuffle mode.</param>
+ /// <param name="mode">The shuffle mode.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the shuffle mode state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the shuffle mode state to the remote device fails.</exception>
public void NotifyShuffleMode(ShuffleMode mode)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="mode">Scan mode.</param>
+ /// <param name="mode">The scan mode.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the Scan mode state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the scan mode state to the remote device fails.</exception>
public void NotifyScanMode(ScanMode mode)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="state">Player state.</param>
+ /// <param name="state">The player state.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the player state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the player state to the remote device fails.</exception>
public void NotifyPlayerState(PlayerState state)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Notifies the current position of song to the remote device.
+ /// Notifies the current position of the song to the remote device.
/// </summary>
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="position">Current position in milliseconds.</param>
+ /// <param name="position">The current position in milliseconds.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the current position state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the current position state to the remote device fails.</exception>
public void NotifyCurrentPosition(uint position)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// <remarks>
/// The remote device must be connected.
/// </remarks>
- /// <param name="trackData">Data of the track.</param>
+ /// <param name="trackData">The data of the track.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when Notifying the shuffle Track state to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when notifying the shuffle track state to the remote device fails.</exception>
public void NotifyTrack(Track trackData)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// A class to handle device class type and service.
+ /// This class is used to handle the device class types and the service.
/// </summary>
public class BluetoothClass
{
}
/// <summary>
- /// Type of the major device class.
+ /// The type of the major device class.
/// </summary>
public BluetoothMajorDeviceClassType MajorDeviceClassType
{
}
}
/// <summary>
- /// Type of the minor device class.
+ /// The type of the minor device class.
/// </summary>
public BluetoothMinorDeviceClassType MinorDeviceClassType
{
}
}
/// <summary>
- /// Major service class mask.
+ /// The major service class mask.
/// </summary>
public int MajorServiceClassMask
{
}
/// <summary>
- /// A class containing the information of Bluetooth oob data.
+ /// This class contains the information of the Bluetooth OOB data.
/// </summary>
public class BluetoothOobData
{
/// <summary>
- /// Default Constructor.Initializes an object of BluetoothOobData
+ /// The default constructor. Initializes an object of the BluetoothOobData.
/// </summary>
public BluetoothOobData()
{
}
/// <summary>
- /// Hash value.
+ /// The hash value.
/// </summary>
public byte[] HashValue
{
set;
}
/// <summary>
- /// Randomizer value.
+ /// The randomizer value.
/// </summary>
public byte[] RandomizerValue
{
}
/// <summary>
- /// A class containing the information of Bluetooth device sdp data.
+ /// This class contains the information of the Bluetooth device SDP data.
/// </summary>
public class BluetoothDeviceSdpData
{
}
/// <summary>
- /// A class containing the information of Bluetooth device connection data.
+ /// This class contains the information of the Bluetooth device connection data.
/// </summary>
public class BluetoothDeviceConnectionData
{
}
/// <summary>
- /// A class containing the information of track data.
+ /// This class contains the information of the track data.
/// </summary>
public class Track
{
/// <summary>
- /// Default Constructor.Initializes an object of Track
+ /// The default constructor. Initializes an object of the track.
/// </summary>
public Track()
{
}
/// <summary>
- /// Title of track.
+ /// The title of the track.
/// </summary>
public string Title
{
set;
}
/// <summary>
- /// Artist of track.
+ /// The artist of the track.
/// </summary>
public string Artist
{
set;
}
/// <summary>
- /// Album of track.
+ /// The album of the track.
/// </summary>
public string Album
{
set;
}
/// <summary>
- /// Genre of track.
+ /// The genre of the track.
/// </summary>
public string Genre
{
set;
}
/// <summary>
- /// Track number.
+ /// The track number.
/// </summary>
public uint TrackNum
{
set;
}
/// <summary>
- /// Number of all tracks.
+ /// The number of all tracks.
/// </summary>
public uint TotalTracks
{
set;
}
/// <summary>
- /// Duration of track in milliseconds.
+ /// The duration of the track in milliseconds.
/// </summary>
public uint Duration
{
}
/// <summary>
- /// A class containing the information of Manufacturer data.
+ /// This class contains the information of the manufacturer data.
/// </summary>
public class ManufacturerData
{
/// <summary>
- /// Default Constructor.Initializes an object of ManufacturerData
+ /// The default Constructor. Initializes an object of the ManufacturerData.
/// </summary>
public ManufacturerData()
{
}
/// <summary>
- /// The manufacturer id.
+ /// The manufacturer ID.
/// </summary>
public int Id
{
}
/// <summary>
- /// A class containing the information of Bluetooth service data.
+ /// This class contains the information of the Bluetooth service data.
/// </summary>
public class BluetoothServiceData
{
/// <summary>
- /// Default Constructor.Initializes an object of BluetoothServiceData
+ /// The default constructor. Initializes an object of the BluetoothServiceData.
/// </summary>
public BluetoothServiceData()
{
}
/// <summary>
- /// The Uuid of service.
+ /// The UUID of the service.
/// </summary>
public string Uuid
{
}
/// <summary>
- /// A class containing the service data information.
+ /// This class contains the service data information.
/// </summary>
public class BluetoothLeServiceData
{
}
/// <summary>
- /// Bluetooth Le service uuid.
+ /// The Bluetooth LE service UUID.
/// </summary>
public string ServiceUuid
{
}
}
/// <summary>
- /// Bluetooth Le service data
+ /// The Bluetooth LE service data.
/// </summary>
public byte[] ServiceData
{
}
/// <summary>
- /// A class containing the information of Socket data.
+ /// This class contains the information of the socket data.
/// </summary>
public class SocketData
{
}
/// <summary>
- /// The socket fd.
+ /// The socket FD.
/// </summary>
public int SocketFd
{
}
/// <summary>
- /// A class containing the information of Socket connection.
+ /// This class contains the information of the socket connection.
/// </summary>
public class SocketConnection
{
}
/// <summary>
- /// The connected socket fd.
+ /// The connected socket FD.
/// </summary>
public int SocketFd
{
}
}
/// <summary>
- /// The service Uuid.
+ /// The service UUID.
/// </summary>
public string ServiceUuid
{
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// A class which is used to handle the connection with other devices and set authorization of other devices.<br>
+ /// This class is used to handle the connection with other devices and set authorization of other devices.<br>
/// The BluetoothDevice class is used to search for services available on remote devices.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
}
/// <summary>
- /// Address of device.
+ /// The address of the device.
/// </summary>
public string Address
{
}
}
/// <summary>
- /// Name of device.
+ /// The name of the device.
/// </summary>
public string Name
{
}
}
/// <summary>
- /// Strength indicator of received signal of device.
+ /// The strength indicator of received signal of the device.
/// </summary>
public int Rssi
{
}
}
/// <summary>
- /// Class of device.
+ /// The class of the device.
/// </summary>
public BluetoothClass Class
{
}
}
/// <summary>
- /// Service UUID list of device.
+ /// The service UUID list of the device.
/// </summary>
public IEnumerable<string> ServiceUuidList
{
}
}
/// <summary>
- /// The paired state of device.
+ /// The paired state of the device.
/// </summary>
public bool IsPaired
{
}
}
/// <summary>
- /// The connection state of device.
+ /// The connection state of the device.
/// </summary>
public bool IsConnected
{
}
}
/// <summary>
- /// The authorization state of device.
+ /// The authorization state of the device.
/// </summary>
public bool IsAuthorized
{
}
}
/// <summary>
- /// Bluetooth Appearance.
+ /// The Bluetooth appearance.
/// </summary>
public BluetoothAppearanceType AppearanceType
{
}
/// <summary>
- /// The length of manufacturer data.
+ /// The length of the manufacturer data.
/// </summary>
public int ManufacturerDataLength
{
}
/// <summary>
- /// (event) BondCreated is raised when process of creating bond is finished.
+ /// The BondCreated event is raised when the process of creating the bond is finished.
/// </summary>
public event EventHandler<BondCreatedEventArgs> BondCreated
{
}
/// <summary>
- /// (event) BondDestroyed is raised when the bond is destroyed.
+ /// The BondDestroyed event is raised when the bond is destroyed.
/// </summary>
public event EventHandler<BondDestroyedEventArgs> BondDestroyed
{
}
/// <summary>
- /// (event) AuthorizationChanged is raised when the authorization of device is changed.
+ /// The AuthorizationChanged event is raised when the authorization of the device is changed.
/// </summary>
public event EventHandler<AuthorizationChangedEventArgs> AuthorizationChanged
{
}
/// <summary>
- /// (event) ServiceSearched is raised when the process of service searched is finished.
+ /// The ServiceSearched event is raised when the process of service searched is finished.
/// </summary>
public event EventHandler<ServiceSearchedEventArgs> ServiceSearched
{
}
/// <summary>
- /// (event) ConnectionStateChanged is raised when the connection state is changed.
+ /// The ConnectionStateChanged event is raised when the connection state is changed.
/// </summary>
public event EventHandler<DeviceConnectionStateChangedEventArgs> ConnectionStateChanged
{
}
/// <summary>
- /// Creates a bond with remote Bluetooth device.
+ /// Creates a bond with the remote Bluetooth device.
/// </summary>
/// <remarks>
- /// The Bluetooth must be enabled and remote device must be discoverable by StartDiscovery().The bond can be destroyed by DestroyBond().
- /// The bonding request can be cancelled by CancelBonding().If this succeeds, BondCreated event will be invoked.
+ /// The Bluetooth must be enabled and the remote device must be discoverable by StartDiscovery(). The bond can be destroyed by DestroyBond().
+ /// The bonding request can be cancelled by CancelBonding(). If this succeeds, the BondCreated event will be invoked.
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when create bond to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the create bonding process to the remote device fails.</exception>
public void CreateBond()
{
if (BluetoothAdapter.IsBluetoothEnabled)
/// <remarks>
/// Bonding must be in progress by CreateBond().
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when cancel bonding procedure to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the cancel bonding procedure to remote device fails.</exception>
public void CancelBonding()
{
int ret = Interop.Bluetooth.CancelBonding();
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled and the bond must be created by CreateBond().
- /// If this succeeds, BondDestroyed event will be invoked.
+ /// If this succeeds, the BondDestroyed event will be invoked.
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when destroy bond procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the destroy bonding procedure fails.</exception>
public void DestroyBond()
{
if (BluetoothAdapter.IsBluetoothEnabled)
/// <remarks>
/// The Bluetooth must be enabled and the bond must be created by CreateBond().
/// </remarks>
- /// <param name="aliasName">Alias name of remote device.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when set alias name to remote device fails.</exception>
+ /// <param name="aliasName">The alias name of the remote device.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the set alias name to remote device fails.</exception>
public void SetAlias(string aliasName)
{
if (BluetoothAdapter.IsBluetoothEnabled)
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled and the bond must be created by CreateBond().
- /// If this succeeds, AuthorizationChanged event will be invoked.
+ /// If this succeeds, the AuthorizationChanged event will be invoked.
/// </remarks>
- /// <param name="authorizationState">Authorization state.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when Set authorization to remote device fails.</exception>
+ /// <param name="authorizationState">The authorization state.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the set authorization to remote device fails.</exception>
public void SetAuthorization(BluetoothAuthorizationType authorizationState)
{
if (BluetoothAdapter.IsBluetoothEnabled)
}
/// <summary>
- /// Gets the mask from UUID.
+ /// Gets the mask from the UUID.
/// </summary>
/// <returns>The service mask list converted from the given UUID list.</returns>
- /// <param name="uuids">Uuid list of the device.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when get Mask from UUID fails.</exception>
+ /// <param name="uuids">The UUID list of the device.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the get Mask from UUID fails.</exception>
public BluetoothServiceClassType GetMaskFromUuid(string[] uuids)
{
BluetoothServiceClassType serviceMask;
/// Starts the search for services supported by the specified device.
/// </summary>
/// <remarks>
- /// The Bluetooth must be enabled and remote device must be discoverable by StartDiscovery().The bond must be created by CreateBond().
- /// If this succeeds, ServiceSearched will be invoked.
+ /// The Bluetooth must be enabled and remote device must be discoverable by StartDiscovery(). The bond must be created by CreateBond().
+ /// If this succeeds, the ServiceSearched event will be invoked.
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device service search fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device service search fails.</exception>
public void StartServiceSearch()
{
Log.Info(Globals.LogTag, "startservicesearch entry");
/// The Bluetooth must be enabled.
/// </remarks>
/// <returns>The connected Bluetooth profiles.</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when there is no BT connection.</exception>
public IEnumerable<BluetoothProfileType> GetConnectedProfiles()
{
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <returns><c>true</c> if profile is connected; otherwise, <c>false</c>.</returns>
- /// <param name="profileType">Bluetooth Profile type.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
+ /// <returns><c>true</c> if profile is connected, otherwise <c>false</c>.</returns>
+ /// <param name="profileType">The Bluetooth profile type.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when there is no BT connection.</exception>
public bool IsProfileConnected(BluetoothProfileType profileType)
{
}
/// <summary>
- /// Returns the instance of Bluetooth profile type.
+ /// Returns the instance of the Bluetooth profile type.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// Creates the client socket.
/// </summary>
/// <returns>The IBluetoothClientSocket instance.</returns>
- /// <param name="serviceUuid">The UUID of service.</param>
+ /// <param name="serviceUuid">The UUID of the service.</param>
public IBluetoothClientSocket CreateSocket(string serviceUuid)
{
BluetoothSocket clientSocket = new BluetoothSocket();
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// Enumeration for Bluetooth state.
+ /// Enumeration for the Bluetooth states.
/// </summary>
public enum BluetoothState
{
/// <summary>
- /// Disabled state.
+ /// The disabled state.
/// </summary>
Disabled = 0,
/// <summary>
- /// Enabled state.
+ /// The enabled state.
/// </summary>
Enabled
}
/// <summary>
- /// Enumeration for Bluetooth errors.
+ /// Enumeration for the Bluetooth errors.
/// </summary>
public enum BluetoothError
{
/// <summary>
- /// Successful
+ /// Successful.
/// </summary>
None = ErrorCode.None,
/// <summary>
- /// Operation cancelled
+ /// Operation canceled.
/// </summary>
Cancelled = ErrorCode.Canceled,
/// <summary>
- /// Invalid parameter
+ /// Invalid parameter.
/// </summary>
InvalidParameter = ErrorCode.InvalidParameter,
/// <summary>
- /// Out of memory
+ /// Out of memory.
/// </summary>
OutOfMemory = ErrorCode.OutOfMemory,
/// <summary>
- /// Device or resource busy
+ /// Device or resource busy.
/// </summary>
ResourceBusy = ErrorCode.ResourceBusy,
/// <summary>
- /// Timeout error
+ /// Timeout error.
/// </summary>
TimedOut = ErrorCode.TimedOut,
/// <summary>
- /// Operation now in progress
+ /// Operation now in progress.
/// </summary>
NowInProgress = ErrorCode.NowInProgress,
/// <summary>
- /// Bluetooth is Not Supported
+ /// Bluetooth is not supported.
/// </summary>
NotSupported = ErrorCode.NotSupported,
/// <summary>
- /// Permission denied
+ /// Permission denied.
/// </summary>
PermissionDenied = ErrorCode.PermissionDenied,
/// <summary>
- /// Quota exceeded
+ /// Quota exceeded.
/// </summary>
QuotaExceeded = ErrorCode.QuotaExceeded,
/// <summary>
- /// No data available
+ /// No data available.
/// </summary>
NoData = ErrorCode.NoData,
/// <summary>
- /// Local adapter not initialized
+ /// Local adapter not initialized.
/// </summary>
NotInitialized = -0x01C00000 | 0x0101,
/// <summary>
- /// Local adapter not enabled
+ /// Local adapter not enabled.
/// </summary>
NotEnabled = -0x01C00000 | 0x0102,
/// <summary>
- /// Operation already done
+ /// Operation already done.
/// </summary>
AlreadyDone = -0x01C00000 | 0x0103,
/// <summary>
- /// Operation failed
+ /// Operation failed.
/// </summary>
OperationFailed = -0x01C00000 | 0x0104,
/// <summary>
- /// Operation not in progress
+ /// Operation not in progress.
/// </summary>
NotInProgress = -0x01C00000 | 0x0105,
/// <summary>
- /// Remote device not bonded
+ /// Remote device not bonded.
/// </summary>
RemoteDeviceNotBonded = -0x01C00000 | 0x0106,
/// <summary>
- /// Authentication rejected
+ /// Authentication rejected.
/// </summary>
AuthRejected = -0x01C00000 | 0x0107,
/// <summary>
- /// Authentication failed
+ /// Authentication failed.
/// </summary>
AuthFailed = -0x01C00000 | 0x0108,
/// <summary>
- /// Remote device not found
+ /// Remote device not found.
/// </summary>
RemoteDeviceNotFound = -0x01C00000 | 0x0109,
/// <summary>
- /// Service search failed
+ /// Service search failed.
/// </summary>
ServiceSearchFailed = -0x01C00000 | 0x010A,
/// <summary>
- /// Remote device is not connected
+ /// Remote device is not connected.
/// </summary>
RemoteDeviceNotConnected = -0x01C00000 | 0x010B,
/// <summary>
- /// Resource temporarily unavailable
+ /// Resource temporarily unavailable.
/// </summary>
ResourceUnavailable = -0x01C00000 | 0x010C,
/// <summary>
- /// Service Not Found
+ /// Service Not Found.
/// </summary>
ServiceNotFound = -0x01C00000 | 0x010D
}
/// <summary>
- /// Enumeration for Bluetooth visibility mode.
+ /// Enumeration for the Bluetooth visibility modes.
/// </summary>
public enum VisibilityMode
{
/// <summary>
- /// Non discoverable mode.
+ /// The non-discoverable mode.
/// </summary>
NonDiscoverable = 0,
/// <summary>
- /// Discoverable mode.
+ /// The discoverable mode.
/// </summary>
Discoverable = 1,
/// <summary>
- /// Discoverable mode with limited time.
+ /// The discoverable mode with limited time.
/// </summary>
TimeLimitedDiscoverable = 2
}
/// <summary>
- /// Enumeration for Bluetooth major device class type.
+ /// Enumeration for the Bluetooth major device class types.
/// </summary>
public enum BluetoothMajorDeviceClassType
{
/// <summary>
- /// Miscellaneous major class type.
+ /// The miscellaneous major class type.
/// </summary>
Misc = 0x00,
/// <summary>
- /// Computer major class type.
+ /// The computer major class type.
/// </summary>
Computer = 0x01,
/// <summary>
- /// Phone major class type.
+ /// The phone major class type.
/// </summary>
Phone = 0x02,
/// <summary>
- /// LAN/Network access point major class type.
+ /// The LAN/Network access point major class type.
/// </summary>
LanNetworkAccessPoint = 0x03,
/// <summary>
- /// Audio/Video major class type.
+ /// The audio/video major class type.
/// </summary>
AudioVideo = 0x04,
/// <summary>
- /// Peripheral major class type.
+ /// The peripheral major class type.
/// </summary>
Peripheral = 0x05,
/// <summary>
- /// Imaging major class type.
+ /// The imaging major class type.
/// </summary>
Imaging = 0x06,
/// <summary>
- /// Wearable major class type.
+ /// The wearable major class type.
/// </summary>
Wearable = 0x07,
/// <summary>
- /// Toy major class type.
+ /// The toy major class type.
/// </summary>
Toy = 0x08,
/// <summary>
- /// Health major class type.
+ /// The health major class type.
/// </summary>
Health = 0x09,
/// <summary>
- /// Uncategorized major class type.
+ /// The uncategorized major class type.
/// </summary>
Uncategorized = 0x1F
}
/// <summary>
- /// Enumeration for Bluetooth minor device class type.
+ /// Enumeration for the Bluetooth minor device class types.
/// </summary>
public enum BluetoothMinorDeviceClassType
{
/// <summary>
- /// Uncategorized computer minor class type.
+ /// The uncategorized computer minor class type.
/// </summary>
ComputerUncategorized = 0x00,
/// <summary>
- /// Desktop workstation computer minor class type.
+ /// The desktop workstation computer minor class type.
/// </summary>
ComputerDesktopWorkstation = 0x04,
/// <summary>
- /// Server computer minor class type.
+ /// The server computer minor class type.
/// </summary>
ComputerServer = 0x08,
/// <summary>
- /// Laptop computer minor class type.
+ /// The laptop computer minor class type.
/// </summary>
ComputerLaptop = 0x0C,
/// <summary>
- /// Handheld PC/PDA computer minor class type.
+ /// The handheld PC/PDA computer minor class type.
/// </summary>
ComputerHandheldPcOrPda = 0x10,
/// <summary>
- /// Palm sized PC/PDA computer minor class type.
+ /// The palm sized PC/PDA computer minor class type.
/// </summary>
ComputerPalmSizedPcOrPda = 0x14,
/// <summary>
- /// Wearable computer minor class type.
+ /// The wearable computer minor class type.
/// </summary>
ComputerWearableComputer = 0x18,
/// <summary>
- /// Unclassified phone minor class type.
+ /// The unclassified phone minor class type.
/// </summary>
PhoneUncategorized = 0x00,
/// <summary>
- /// Cellular phone minor class type.
+ /// The cellular phone minor class type.
/// </summary>
PhoneCellular = 0x04,
/// <summary>
- /// Cordless phone minor class type.
+ /// The cordless phone minor class type.
/// </summary>
PhoneCordless = 0x08,
/// <summary>
- /// SmartPhone phone minor class type.
+ /// The smartphone phone minor class type.
/// </summary>
PhoneSmartPhone = 0x0C,
/// <summary>
- /// Wired modem or voice gateway phone minor class type.
+ /// The wired modem or voice gateway phone minor class type.
/// </summary>
PhoneWiredModemOrVoiceGateway = 0x10,
/// <summary>
- /// ISDN phone minor class type.
+ /// The ISDN phone minor class type.
/// </summary>
PhoneCommonIsdnAccess = 0x14,
LanNetworkAccessPointNoServiceAvailable = 0xE0,
/// <summary>
- /// Uncategorized audio/video minor class type.
+ /// The uncategorized audio/video minor class type.
/// </summary>
AudioVideoUncategorized = 0x00,
/// <summary>
- /// Wearable headset audio/video minor class type.
+ /// The wearable headset audio/video minor class type.
/// </summary>
AudioVideoWearableHeadset = 0x04,
/// <summary>
- /// Hands free audio/video minor class type.
+ /// The hands free audio/video minor class type.
/// </summary>
AudioVideoHandsFree = 0x08,
/// <summary>
- /// Microphone audio/video minor class type.
+ /// The microphone audio/video minor class type.
/// </summary>
AudioVideoMicrophone = 0x10,
/// <summary>
- /// Loudspeaker audio/video minor class type.
+ /// The loudspeaker audio/video minor class type.
/// </summary>
AudioVideoLoudspeaker = 0x14,
/// <summary>
- /// Headphones audio/video minor class type.
+ /// The headphones audio/video minor class type.
/// </summary>
AudioVideoHeadphones = 0x18,
/// <summary>
- /// Portable audio audio/video minor class type.
+ /// The portable audio audio/video minor class type.
/// </summary>
AudioVideoPortableAudio = 0x1C,
/// <summary>
- /// Car audio audio/video minor class type.
+ /// The car audio audio/video minor class type.
/// </summary>
AudioVideoCarAudio = 0x20,
/// <summary>
- /// SetTopbox audio/video minor class type.
+ /// The SetTopbox audio/video minor class type.
/// </summary>
AudioVideoSetTopBox = 0x24,
/// <summary>
- /// Hifi audio audio/video minor class type.
+ /// The Hi-Fi audio/video minor class type.
/// </summary>
AudioVideoHifiAudioDevice = 0x28,
/// <summary>
- /// VCR audio/video minor class type.
+ /// The VCR audio/video minor class type.
/// </summary>
AudioVideoVcr = 0x2C,
/// <summary>
- /// Video camera audio/video minor class type.
+ /// The video camera audio/video minor class type.
/// </summary>
AudioVideoVideoCamera = 0x30,
/// <summary>
/// </summary>
AudioVideoCamcorder = 0x34,
/// <summary>
- /// Video monitor audio/video minor class type.
+ /// The video monitor audio/video minor class type.
/// </summary>
AudioVideoVideoMonitor = 0x38,
/// <summary>
- /// Video display and loudspeaker audio/video minor class type.
+ /// The video display and loudspeaker audio/video minor class type.
/// </summary>
AudioVideoVideoDisplayLoudspeaker = 0x3C,
/// <summary>
- /// Video conferencing audio/video minor class type.
+ /// The video conferencing audio/video minor class type.
/// </summary>
AudioVideoVideoConferencing = 0x40,
/// <summary>
- /// Gaming/toy audio/video minor class type.
+ /// The gaming/toy audio/video minor class type.
/// </summary>
AudioVideoGamingToy = 0x48,
/// <summary>
- /// Uncategorized peripheral minor class type.
+ /// The uncategorized peripheral minor class type.
/// </summary>
PeripheralUncategorized = 0x00,
/// <summary>
- /// Keyboard peripheral minor class type.
+ /// The keyboard peripheral minor class type.
/// </summary>
PeripheralKeyBoard = 0x40,
/// <summary>
- /// Pointing device peripheral minor class type.
+ /// The pointing device peripheral minor class type.
/// </summary>
PeripheralPointingDevice = 0x80,
/// <summary>
- /// Combo keyboard peripheral minor class type.
+ /// The combo keyboard peripheral minor class type.
/// </summary>
PeripheralComboKeyboardPointingDevice = 0xC0,
/// <summary>
- /// Joystick peripheral minor class type.
+ /// The joystick peripheral minor class type.
/// </summary>
PeripheralJoystick = 0x04,
/// <summary>
- /// Game pad peripheral minor class type.
+ /// The game pad peripheral minor class type.
/// </summary>
PeripheralGamePad = 0x08,
/// <summary>
- /// Remote control peripheral minor class type.
+ /// The remote control peripheral minor class type.
/// </summary>
PeripheralRemoteControl = 0x0C,
/// <summary>
- /// Sensing device peripheral minor class type.
+ /// The sensing device peripheral minor class type.
/// </summary>
PeripheralSensingDevice = 0x10,
/// <summary>
- /// Digitizer peripheral minor class type.
+ /// The digitizer peripheral minor class type.
/// </summary>
PeripheralDigitizerTablet = 0x14,
/// <summary>
- /// Card reader peripheral minor class type.
+ /// The card reader peripheral minor class type.
/// </summary>
PeripheralCardReader = 0x18,
/// <summary>
- /// Digital pen peripheral minor class type.
+ /// The digital pen peripheral minor class type.
/// </summary>
PeripheralDigitalPen = 0x1C,
/// <summary>
- /// Handheld scanner peripheral minor class type.
+ /// The handheld scanner peripheral minor class type.
/// </summary>
PeripheralHandheldScanner = 0x20,
/// <summary>
- /// Handheld gestural input computer minor class type.
+ /// The handheld gestural input computer minor class type.
/// </summary>
PeripheralHandheldGesturalInputDevice = 0x24,
/// <summary>
- /// Display imaging minor class type.
+ /// The display imaging minor class type.
/// </summary>
ImagingDisplay = 0x10,
/// <summary>
- /// Camera imaging minor class type.
+ /// The camera imaging minor class type.
/// </summary>
ImagingCamera = 0x20,
/// <summary>
- /// Scanner imaging minor class type.
+ /// The scanner imaging minor class type.
/// </summary>
ImagingScanner = 0x40,
/// <summary>
- /// Printer imaging minor class type.
+ /// The printer imaging minor class type.
/// </summary>
ImagingPrinter = 0x80,
/// <summary>
- /// Wrist watch wearable minor class type.
+ /// The wrist watch wearable minor class type.
/// </summary>
WearableWristWatch = 0x04,
/// <summary>
- /// Pager wearable minor class type.
+ /// The pager wearable minor class type.
/// </summary>
WearablePager = 0x08,
/// <summary>
- /// Jacket wearable minor class type.
+ /// The jacket wearable minor class type.
/// </summary>
WearableJacket = 0x0C,
/// <summary>
- /// Helmet wearable minor class type.
+ /// The helmet wearable minor class type.
/// </summary>
WearableHelmet = 0x10,
/// <summary>
- /// Glasses wearable minor class type.
+ /// The glasses wearable minor class type.
/// </summary>
WearableGlasses = 0x14,
/// <summary>
- /// Robot toy minor class type.
+ /// The robot toy minor class type.
/// </summary>
ToyRobot = 0x04,
/// <summary>
- /// Vehicle toy minor class type.
+ /// The vehicle toy minor class type.
/// </summary>
ToyVehicle = 0x08,
/// <summary>
- /// Doll toy minor class type.
+ /// The doll toy minor class type.
/// </summary>
ToyDollAction = 0x0C,
/// <summary>
- /// Controller toy minor class type.
+ /// The controller toy minor class type.
/// </summary>
ToyController = 0x10,
/// <summary>
- /// Game toy minor class type.
+ /// The game toy minor class type.
/// </summary>
ToyGame = 0x14,
/// <summary>
- /// Uncategorized health minor class type.
+ /// The uncategorized health minor class type.
/// </summary>
HealthUncategorized = 0x00,
/// <summary>
- /// BP monitor health minor class type.
+ /// The BP monitor health minor class type.
/// </summary>
HealthBloodPressureMonitor = 0x04,
/// <summary>
- /// Thermometer health minor class type.
+ /// The thermometer health minor class type.
/// </summary>
HealthThermometer = 0x08,
/// <summary>
- /// Scale health minor class type.
+ /// The scale health minor class type.
/// </summary>
HealthWeighingScale = 0x0C,
/// <summary>
- /// Glucose meter health minor class type.
+ /// The glucose meter health minor class type.
/// </summary>
HealthGlucoseMeter= 0x10,
/// <summary>
- /// Pulse oximeter health minor class type.
+ /// The pulse oximeter health minor class type.
/// </summary>
HealthPulseOximeter = 0x14,
/// <summary>
- /// Heart/Pulse rate monitor health minor class type.
+ /// The heart/pulse rate monitor health minor class type.
/// </summary>
HealthHeartPulseRateMonitor = 0x18,
/// <summary>
- /// Display health minor class type.
+ /// The display health minor class type.
/// </summary>
HealthDataDisplay = 0x1C,
/// <summary>
- /// Step counter health minor class type.
+ /// The step counter health minor class type.
/// </summary>
HealthStepCounter = 0x20,
/// <summary>
- /// Body composition analyzer health minor class type.
+ /// The body composition analyzer health minor class type.
/// </summary>
HealthBodyCompositionAnalyzer = 0x24,
/// <summary>
- /// Peak flow monitor health minor class type.
+ /// The peak flow monitor health minor class type.
/// </summary>
HealthPeakFlowMonitor = 0x28,
/// <summary>
- /// Medication monitor health minor class type.
+ /// The medication monitor health minor class type.
/// </summary>
HealthMedicationMonitor = 0x2C,
/// <summary>
- /// Knee prosthesis health minor class type.
+ /// The knee prosthesis health minor class type.
/// </summary>
HealthKneeProsthesis = 0x30,
/// <summary>
- /// Ankle prosthesis health minor class type.
+ /// The ankle prosthesis health minor class type.
/// </summary>
HealthAnkleProsthesis = 0x34
}
/// <summary>
- /// Enumeration for Bluetooth device discovery state.
+ /// Enumeration for the Bluetooth device discovery states.
/// </summary>
public enum BluetoothDeviceDiscoveryState
{
/// <summary>
- /// Device discovery is started.
+ /// The device discovery is started.
/// </summary>
Started = 0,
/// <summary>
- /// Device discovery is finished.
+ /// The device discovery is finished.
/// </summary>
Finished,
/// <summary>
}
/// <summary>
- /// Enumeration for Bluetooth appearance type.
+ /// Enumeration for the Bluetooth appearance types.
/// </summary>
public enum BluetoothAppearanceType
{
}
/// <summary>
- /// Enumeration for Bluetooth audio profile type.
+ /// Enumeration for the Bluetooth audio profile types.
/// </summary>
public enum BluetoothAudioProfileType
{
/// </summary>
All = 0,
/// <summary>
- /// Headset and Hands-Free profile.
+ /// The Headset and Hands-Free profile.
/// </summary>
HspHfp,
/// <summary>
- /// Advanced audio distribution profile.
+ /// The Advanced Audio Distribution profile.
/// </summary>
AdvancedAudioDistribution,
/// <summary>
- /// Audio Gateway profile.
+ /// The Audio Gateway profile.
/// </summary>
AudioGateway,
/// <summary>
- /// Advanced Audio Distribution profile sink role.
+ /// The Advanced Audio Distribution profile sink role.
/// </summary>
AdvancedAudioDistributionSink
}
/// <summary>
- /// Enumeration for Bluetooth service class type.
+ /// Enumeration for the Bluetooth service class types.
/// </summary>
public enum BluetoothServiceClassType
{
/// </summary>
None = 0,
/// <summary>
- /// Res service class.
+ /// The RES service class.
/// </summary>
Res = 0x00000001,
/// <summary>
- /// Spp service class.
+ /// The SPP service class.
/// </summary>
Spp = 0x00000002,
/// <summary>
- /// Dun service class.
+ /// The DUN service class.
/// </summary>
Dun = 0x00000004,
/// <summary>
- /// Fax service class.
+ /// The FAX service class.
/// </summary>
Fax = 0x00000008,
/// <summary>
- /// Lap service class.
+ /// The LAP service class.
/// </summary>
Lap = 0x00000010,
/// <summary>
- /// Hsp service class.
+ /// The HSP service class.
/// </summary>
Hsp = 0x00000020,
/// <summary>
- /// Hfp service class.
+ /// The HFPservice class.
/// </summary>
Hfp = 0x00000040,
/// <summary>
- /// Opp service class.
+ /// The OPP service class.
/// </summary>
Opp = 0x00000080,
/// <summary>
- /// Ftp service class.
+ /// The FTP service class.
/// </summary>
Ftp = 0x00000100,
/// <summary>
- /// Ctp service class.
+ /// The CTP service class.
/// </summary>
Ctp = 0x00000200,
/// <summary>
- /// Icp service class.
+ /// The ICP service class.
/// </summary>
Icp = 0x00000400,
/// <summary>
- /// Sync service class.
+ /// The Sync service class.
/// </summary>
Sync = 0x00000800,
/// <summary>
- /// Bpp service class.
+ /// The BPP service class.
/// </summary>
Bpp = 0x00001000,
/// <summary>
- /// Bip service class.
+ /// The BPP service class.
/// </summary>
Bip = 0x00002000,
/// <summary>
- /// Panu service class.
+ /// The Panu service class.
/// </summary>
Panu = 0x00004000,
/// <summary>
- /// Nap service class.
+ /// The NAP service class.
/// </summary>
Nap = 0x00008000,
/// <summary>
- /// Gn service class.
+ /// The GN service class.
/// </summary>
Gn = 0x00010000,
/// <summary>
- /// Sap service class.
+ /// The SAP service class.
/// </summary>
Sap = 0x00020000,
/// <summary>
- /// A2dp service class.
+ /// The A2DP service class.
/// </summary>
A2dp = 0x00040000,
/// <summary>
- /// Avrcp service class.
+ /// The AVRCP service class.
/// </summary>
Avrcp = 0x00080000,
/// <summary>
- /// Pbap service class.
+ /// The PBAP service class.
/// </summary>
Pbap = 0x00100000,
/// <summary>
- /// Hid service class.
+ /// The HID service class.
/// </summary>
Hid = 0x00200000,
/// <summary>
- /// A2dp Source service class.
+ /// The A2DP Source service class.
/// </summary>
A2dpSource = 0x00400000,
/// <summary>
/// </summary>
All = 0x00FFFFFF,
/// <summary>
- /// Max service class.
+ /// The Max service class.
/// </summary>
Max
}
/// <summary>
- /// Enumeration for Bluetooth profile type.
+ /// Enumeration for the Bluetooth profile types.
/// </summary>
public enum BluetoothProfileType
{
/// <summary>
- /// Rfcomm profile.
+ /// The RFCOMM profile.
/// </summary>
Rfcomm = 0,
/// <summary>
- /// Advanced Audio Distribution Profile Source role
+ /// The Advanced Audio Distribution Profile Source role.
/// </summary>
AdvancedAudioDistribution,
/// <summary>
- /// Headset profile.
+ /// The Headset profile.
/// </summary>
Headset,
/// <summary>
- /// Human Interface Device profile.
+ /// The Human Interface Device profile.
/// </summary>
HumanInterfaceDevice,
/// <summary>
- /// Network Access Point profile.
+ /// The Network Access Point profile.
/// </summary>
NetworkAccessPoint,
/// <summary>
- /// Audio Gateway profile.
+ /// The Audio Gateway profile.
/// </summary>
AudioGateway,
/// <summary>
- /// Generic Attribute profile.
+ /// The Generic Attribute profile.
/// </summary>
GenericAttribute,
/// <summary>
- /// Nap Server profile.
+ /// The Nap Server profile.
/// </summary>
NapServer,
/// <summary>
- /// Advanced Audio Distribution profile sink role.
+ /// The advanced Audio Distribution profile sink role.
/// </summary>
AdvancedAudioDistributionSink
}
/// <summary>
- /// Enumeration for Bluetooth authorization type.
+ /// Enumeration for the Bluetooth authorization types.
/// </summary>
public enum BluetoothAuthorizationType
{
/// <summary>
- /// Authorized type.
+ /// The authorized type.
/// </summary>
Authorized = 0,
/// <summary>
- /// Unauthorized type.
+ /// The unauthorized type.
/// </summary>
Unauthorized
}
/// <summary>
- /// Enumeration for Bluetooth connection link type.
+ /// Enumeration for the Bluetooth connection link types.
/// </summary>
public enum BluetoothConnectionLinkType
{
/// <summary>
- /// BR/EDR link.
+ /// The BR/EDR link.
/// </summary>
BrEdr = 0,
/// <summary>
- /// LE link.
+ /// The LE link.
/// </summary>
Le,
/// <summary>
}
/// <summary>
- /// Enumeration for Bluetooth disconnect reason.
+ /// Enumeration for the Bluetooth disconnect reason.
/// </summary>
public enum BluetoothDisconnectReason
{
/// <summary>
- /// Disconnected by unknown reason.
+ /// The disconnected by unknown reason.
/// </summary>
Unknown = 0,
/// <summary>
- /// Disconnected by timeout.
+ /// The disconnected by timeout.
/// </summary>
Timeout,
/// <summary>
- /// Disconnected by local host.
+ /// The disconnected by local host.
/// </summary>
LocalHost,
/// <summary>
- /// Disconnected by remote.
+ /// The disconnected by remote.
/// </summary>
Remote
}
/// <summary>
- /// Enumerations of connected Bluetooth device event role.
+ /// Enumeration for the connected Bluetooth device event roles.
/// </summary>
public enum BluetoothSocketRole
{
/// </summary>
Unknown,
/// <summary>
- /// Server role.
+ /// The server role.
/// </summary>
Server,
/// <summary>
- /// Client role.
+ /// The client role.
/// </summary>
Client
}
/// <summary>
- /// Enumerations of Bluetooth socket connection state.
+ /// Enumeration for the Bluetooth socket connection states.
/// </summary>
public enum BluetoothSocketState
{
/// <summary>
- /// RFCOMM is connected.
+ /// The RFCOMM is connected.
/// </summary>
Connected,
/// <summary>
- /// RFCOMM is disconnected.
+ /// The RFCOMM is disconnected.
/// </summary>
Disconnected
}
/// <summary>
- /// Enumeration for equalizer state.
+ /// Enumeration for the equalizer states.
/// </summary>
public enum EqualizerState
{
}
/// <summary>
- /// Enumeration for repeat mode.
+ /// Enumeration for the repeat modes.
/// </summary>
public enum RepeatMode
{
}
/// <summary>
- /// Enumeration for shuffle mode.
+ /// Enumeration for the shuffle modes.
/// </summary>
public enum ShuffleMode
{
}
/// <summary>
- /// Enumeration for scan mode.
+ /// Enumeration for the scan modes.
/// </summary>
public enum ScanMode
{
}
/// <summary>
- /// Enumeration for player state.
+ /// Enumeration for the player states.
/// </summary>
public enum PlayerState
{
/// <summary>
- /// Stopped state.
+ /// The stopped state.
/// </summary>
Stopped = 0,
/// <summary>
- /// Playing state.
+ /// The playing state.
/// </summary>
Playing,
/// <summary>
- /// Paused state.
+ /// The paused state.
/// </summary>
Paused,
/// <summary>
- /// Seek forward state.
+ /// The seek forward state.
/// </summary>
SeekForward,
/// <summary>
- /// Seek rewind state.
+ /// The seek rewind state.
/// </summary>
SeekRewind
}
/// <summary>
- /// Enumeration for Bluetooth Le device address type.
+ /// Enumeration for the Bluetooth LE device address types.
/// </summary>
public enum BluetoothLeDeviceAddressType
{
/// <summary>
- /// The bluetooth le public address.
+ /// The Buetooth LE public address.
/// </summary>
BluetoothLePublicAddress,
/// <summary>
- /// The bluetooth le private address.
+ /// The Bluetooth LE private address.
/// </summary>
BluetoothLePrivateAddress
}
/// <summary>
- /// Enumeration for Bluetooth LePacket type.
+ /// Enumeration for the Bluetooth LePacket types.
/// </summary>
public enum BluetoothLePacketType
{
/// <summary>
- /// The bluetooth le advertising packet.
+ /// The Bluetooth LE advertising packet.
/// </summary>
BluetoothLeAdvertisingPacket,
/// <summary>
- /// The bluetooth le scan response packet.
+ /// The Bluetooth LE scan response packet.
/// </summary>
BluetoothLeScanResponsePacket
}
/// <summary>
- /// Enumeration for Bluetooth Le data type.
+ /// Enumeration for the Bluetooth LE data types.
/// </summary>
public enum BluetoothLeDataType
{
/// <summary>
- /// The bluetooth le packet data list 16 bit service uuid.
+ /// The Bluetooth LE packet data list 16 bit service uuid.
/// </summary>
BluetoothLePacketDataList16BitServiceUuid,
/// <summary>
- /// The bluetooth le packet manufacturer data.
+ /// The Bluetooth LE packet manufacturer data.
/// </summary>
BluetoothLePacketManufacturerData
}
/// <summary>
- /// Enumeration for Bluetooth Le Advertising mode type.
+ /// Enumeration for the Bluetooth LE advertising mode types.
/// </summary>
public enum BluetoothLeAdvertisingMode
{
/// <summary>
- /// The bluetooth le advertising balanced mode.
+ /// The Bluetooth LE advertising balanced mode.
/// </summary>
BluetoothLeAdvertisingBalancedMode,
/// <summary>
- /// The bluetooth le advertising low latency mode.
+ /// The Bluetooth LE advertising low latency mode.
/// </summary>
BluetoothLeAdvertisingLowLatencyMode,
/// <summary>
- /// The bluetooth le advertising low energy mode.
+ /// The Bluetooth LE advertising low energy mode.
/// </summary>
BluetoothLeAdvertisingLowEnergyMode
}
/// <summary>
- /// Enumeration for Bluetooth Le Advertising mode type.
+ /// Enumeration for the Bluetooth LE advertising mode type.
/// </summary>
public enum BluetoothLeAdvertisingState
{
/// <summary>
- /// The bluetooth le advertising stopped.
+ /// The Bluetooth LE advertising stopped.
/// </summary>
BluetoothLeAdvertisingStopped,
/// <summary>
- /// The bluetooth le advertising started.
+ /// The Bluetooth LE advertising started.
/// </summary>
BluetoothLeAdvertisingStarted
}
/// <summary>
- /// Enumerations of the integer type for GATT handle's value.
+ /// Enumeration for the integer type for GATT handle's values.
/// </summary>
public enum IntDataType
{
/// <summary>
- /// 8 bit signed int type.
+ /// The 8-bit signed integer type.
/// </summary>
SignedInt8,
/// <summary>
- /// 16 bit signed int type.
+ /// The 16-bit signed integer type.
/// </summary>
SignedInt16,
/// <summary>
- /// 32 bit signed int type.
+ /// The 32-bit signed integer type.
/// </summary>
SignedInt32,
/// <summary>
- /// 8 bit unsigned int type.
+ /// The 8-bit unsigned integer type.
/// </summary>
UnsignedInt8,
/// <summary>
- /// 16 bit unsigned int type.
+ /// The 16-bit unsigned integer type.
/// </summary>
UnsignedInt16,
/// <summary>
- /// 32 bit unsigned int type.
+ /// The 32-bit unsigned integer type.
/// </summary>
UnsignedInt32
}
/// <summary>
- /// Enumerations of the float type for GATT handle's value.
+ /// Enumerations of the float type for GATT handle's values.
/// </summary>
public enum FloatDataType
{
/// <summary>
- /// 32 bit float type.
+ /// The 32-bit float type.
/// </summary>
Float,
/// <summary>
- /// 16 bit float type.
+ /// The 16-bit float type.
/// </summary>
SFloat,
}
/// <summary>
- /// Enumerations of the GATT handle's type.
+ /// Enumeration for the GATT handle's types.
/// </summary>
public enum GattHandleType
{
/// <summary>
- /// GATT service type.
+ /// The GATT service type.
/// </summary>
Service,
/// <summary>
- /// GATT characteristic type.
+ /// The GATT characteristic type.
/// </summary>
Characteristic,
/// <summary>
- /// GATT descriptor type.
+ /// The GATT descriptor type.
/// </summary>
Descriptor
}
/// <summary>
- /// Enumerations of the service type.
+ /// Enumeration for the service types.
/// </summary>
public enum BluetoothGattServiceType
{
/// <summary>
- /// GATT primary service type.
+ /// The GATT primary service type.
/// </summary>
Primary,
/// <summary>
- /// GATT secondary service type.
+ /// The GATT secondary service type.
/// </summary>
Secondary
}
/// <summary>
- /// Enumerations of the characteristic's property.
+ /// Enumeration for the characteristic's property.
/// </summary>
[Flags]
public enum BluetoothGattProperty
{
/// <summary>
- /// Broadcast property.
+ /// The broadcast property.
/// </summary>
Broadcast = 1,
/// <summary>
- /// Read property.
+ /// The read property.
/// </summary>
Read = 2,
/// <summary>
- /// Write without response property.
+ /// The write without response property.
/// </summary>
WriteWithoutResponse = 4,
/// <summary>
- /// Write property.
+ /// The write property.
/// </summary>
Write = 8,
/// <summary>
- /// Notify property.
+ /// The notify property.
/// </summary>
Notify = 16,
/// <summary>
- /// Indicate property.
+ /// The indicate property.
/// </summary>
Indicate = 32,
/// <summary>
- /// Authenticated signed writes property.
+ /// The authenticated signed writes property.
/// </summary>
AuthenticatedSignedWrites = 64,
/// <summary>
- /// Extended properties.
+ /// The extended properties.
/// </summary>
ExtendedProperties = 128,
}
/// <summary>
- /// Enumerations of bluetooth gatt permission type.
+ /// Enumeration for the Bluetooth GATT permission types.
/// </summary>
[Flags]
public enum BluetoothGattPermission
}
/// <summary>
- /// Enumerations of the write type.
+ /// Enumeration for the write types.
/// </summary>
public enum BluetoothGattWriteType
{
/// <summary>
- /// Write without response.
+ /// The write without response.
/// </summary>
NoResponse,
/// <summary>
- /// Write with response.
+ /// The write with response.
/// </summary>
WriteWithResponse
}
/// <summary>
- /// Enumerations of the remote device request types for attributes
+ /// Enumeration for the remote device request types for attributes.
/// </summary>
public enum BluetoothGattRequestType
{
/// <summary>
- /// Read Requested.
+ /// Read requested.
/// </summary>
Read = 0,
/// <summary>
- /// Write Requested.
+ /// Write requested.
/// </summary>
Write = 1,
}
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth state.
+ /// An extended EventArgs class contains the changed Bluetooth state.
/// </summary>
public class StateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth name.
+ /// An extended EventArgs class contains the changed Bluetooth name.
/// </summary>
public class NameChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth visibility mode.
+ /// An extended EventArgs class contains the changed Bluetooth visibility mode.
/// </summary>
public class VisibilityModeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the duration until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable.
+ /// An extended EventArgs class contains the duration until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable.
/// </summary>
public class VisibilityDurationChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth device discovery state and the discovered device information.
+ /// An extended EventArgs class contains the changed Bluetooth device discovery state and the discovered device information.
/// </summary>
public class DiscoveryStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the bonded device information.
+ /// An extended EventArgs class contains the bonded device information.
/// </summary>
public class BondCreatedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the address of the remote Bluetooth device to destroy bond with.
+ /// An extended EventArgs class contains the address of the remote Bluetooth device to destroy bond with.
/// </summary>
public class BondDestroyedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the authorization state and address of the remote Bluetooth device.
+ /// An extended EventArgs class contains the authorization state and the address of the remote Bluetooth device.
/// </summary>
public class AuthorizationChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the service lists found on the remote Bluetooth device.
+ /// An extended EventArgs class contains the service lists found on the remote Bluetooth device.
/// </summary>
public class ServiceSearchedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the connection state and connection information of the remote device.
+ /// An extended EventArgs class contains the connection state and the connection information of the remote device.
/// </summary>
public class DeviceConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains data received information.
+ /// An extended EventArgs class contains the data received information.
/// </summary>
public class SocketDataReceivedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains changed connection state.
+ /// An extended EventArgs class contains the changed connection state.
/// </summary>
public class SocketConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the connection state,remote address and the type of audio profile.
+ /// An extended EventArgs class contains the connection state, remote address, and the type of audio profile.
/// </summary>
public class AudioConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the connection state and address of the remote Bluetooth device.
+ /// An extended EventArgs class contains the connection state and the address of the remote Bluetooth device.
/// </summary>
public class HidConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the changed equalizer state.
+ /// An extended EventArgs class contains the changed equalizer state.
/// </summary>
public class EqualizerStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The state of equalizer.
+ /// The state of the equalizer.
/// </summary>
public EqualizerState State
{
}
/// <summary>
- /// An extended EventArgs class which contains the changed repeat mode.
+ /// An extended EventArgs class contains the changed repeat mode.
/// </summary>
public class RepeatModeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the changed shuffle mode.
+ /// An extended EventArgs class contains the changed shuffle mode.
/// </summary>
public class ShuffleModeChangedeventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the changed scan mode.
+ /// An extended EventArgs class contains the changed scan mode.
/// </summary>
public class ScanModeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains the connection state and the remote device address.
+ /// An extended EventArgs class contains the connection state and the remote device address.
/// </summary>
public class TargetConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth LE advertising state changed information.
+ /// An extended EventArgs class contains the changed Bluetooth LE advertising state changed information.
/// </summary>
public class AdvertisingStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The Le advertising state.
+ /// The LE advertising state.
/// </summary>
public BluetoothLeAdvertisingState State
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth LE scan result information.
+ /// An extended EventArgs class contains the changed Bluetooth LE scan result information.
/// </summary>
public class AdapterLeScanResultChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The Le device data.
+ /// The LE device data.
/// </summary>
public BluetoothLeDevice DeviceData
{
}
/// <summary>
- /// An extended EventArgs class which contains changed Bluetooth LE GATT connection state.
+ /// An extended EventArgs class contains the changed Bluetooth LE GATT connection state.
/// </summary>
public class GattConnectionStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains changed attribute value.
+ /// An extended EventArgs class contains the changed attribute value.
/// </summary>
public class ValueChangedEventArgs : EventArgs
{
}
/// <summary>
- /// An extended EventArgs class which contains read value request data.
+ /// An extended EventArgs class contains the read value request data.
/// </summary>
public class ReadRequestedEventArgs : EventArgs
{
}
/// <summary>
- /// The gatt server instance.
+ /// The GATT server instance.
/// </summary>
public BluetoothGattServer Server { get; }
/// <summary>
}
/// <summary>
- /// An extended EventArgs class which contains read value request data.
+ /// An extended EventArgs class contains the read value request data.
/// </summary>
public class WriteRequestedEventArgs : EventArgs
{
}
/// <summary>
- /// The gatt server instance.
+ /// The GATT server instance.
/// </summary>
public BluetoothGattServer Server { get; }
/// <summary>
}
/// <summary>
- /// An extended EventArgs class which contains client preference to enables or disables the Notification/Indication.
+ /// An extended EventArgs class contains the client preference to enable or disable the Notification/Indication.
/// </summary>
public class NotificationStateChangedEventArg : EventArgs
{
}
/// <summary>
- /// The gatt server instance.
+ /// The GATT server instance.
/// </summary>
public BluetoothGattServer Server { get; }
/// <summary>
- /// A value indicating whether the notification is enabled
+ /// A value indicating whether the notification is enabled.
/// </summary>
public bool Value { get; }
}
/// <summary>
- /// An extended EventArgs class which contains read value request data.
+ /// An extended EventArgs class contains the read value request data.
/// </summary>
public class NotificationSentEventArg : EventArgs
{
}
/// <summary>
- /// The gatt server instance.
+ /// The GATT server instance.
/// </summary>
public BluetoothGattServer Server { get; }
/// <summary>
/// </summary>
public int Result { get; }
/// <summary>
- /// Gets a value indicating whether notification sent is completed.
+ /// Gets a value indicating whether the notification sent is completed.
/// </summary>
public bool Completed { get; }
}
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// Bluetooth GATT server
+ /// The Bluetooth GATT server.
/// </summary>
public class BluetoothGattServer
{
}
/// <summary>
- /// (event) called when indication acknowledgement received, once for each notified client
+ /// (event) This event is called when the indication acknowledgement is received for each notified client.
/// </summary>
public event EventHandler<NotificationSentEventArg> NotificationSent
{
}
/// <summary>
- /// Creates bluetooth gatt server
+ /// Creates the Bluetooth GATT server.
/// </summary>
/// <returns></returns>
/// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when create gatt server fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the create GATT server fails.</exception>
public static BluetoothGattServer CreateServer()
{
if (_instance == null)
}
/// <summary>
- /// Registers the server along with the GATT services of the application it is hosting
+ /// Registers the server along with the GATT services of the application it is hosting.
/// </summary>
/// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when register server application fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the register server application fails.</exception>
public void Start()
{
_impl.Start();
}
/// <summary>
- /// Registers a specified service to this server
+ /// Registers a specified service to this server.
/// </summary>
- /// <param name="service">service, which needs to be registered with this server</param>
+ /// <param name="service">The service, which needs to be registered with this server.</param>
/// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when register service fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the register service fails.</exception>
public void RegisterGattService(BluetoothGattService service)
{
if (service.IsRegistered())
}
/// <summary>
- /// Unregisters a specified service from this server
+ /// Unregisters a specified service from this server.
/// </summary>
- /// <param name="service">service, which needs to be unregistered from this server</param>
+ /// <param name="service">The service, which needs to be unregistered from this server.</param>
/// <remarks>
- /// Once unregistered, service object will become invalid and should not be used to access sevices's or any children attribute's methods/ members.
+ /// Once unregistered, the service object will become invalid and should not be used to access sevices or any children attribute's methods/members.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when unregister service fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the unregister service fails.</exception>
public void UnregisterGattService(BluetoothGattService service)
{
if (service.GetGattServer() != this)
}
/// <summary>
- /// Unregisters all services from this server
+ /// Unregisters all services from this server.
/// </summary>
/// <remarks>
- /// Once unregistered, servicees will become invalid and should not be used to access sevices's or any children attribute's methods/ members.
+ /// Once unregistered, servicees will become invalid and should not be used to access sevices or any children attribute's methods/members.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when unregister all services fail.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the unregister all services fail.</exception>
public void UnregisterGattServices()
{
_impl.UnregisterAllGattServices(this);
/// <summary>
/// Gets service with given UUID that belongs to this server.
/// </summary>
- /// <param name="uuid">UUID for the service to get</param>
- /// <returns>service with given uuid if it exists, null otherwise</returns>
+ /// <param name="uuid">The UUID for the service to get.</param>
+ /// <returns>The Service with the given UUID if it exists, null otherwise.</returns>
public BluetoothGattService GetService(string uuid)
{
return _impl.GetService(this, uuid);
}
/// <summary>
- /// Gets list of services that belongs to this server.
+ /// Gets the list of services that belongs to this server.
/// </summary>
- /// <returns>list of services that belongs to this server</returns>
+ /// <returns>The list of services that belongs to this server.</returns>
public IEnumerable<BluetoothGattService> GetServices()
{
return _impl.GetServices(this);
}
/// <summary>
- /// Send indication for value change of the characteristic to the remote devices
+ /// Sends indication for the value change of the characteristic to the remote devices.
/// </summary>
- /// <param name="characteristic">characteristic whose value is changes</param>
- /// <param name="clientAddress">Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when service is not registered or when cccd is not enabled.</exception>
+ /// <param name="characteristic">The characteristic whose the value is changed.</param>
+ /// <param name="clientAddress">The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled.</exception>
public async Task<bool> SendIndicationAsync(BluetoothGattCharacteristic characteristic, string clientAddress)
{
return await _impl.SendIndicationAsync(this, characteristic, clientAddress);
}
/// <summary>
- /// Send notification for value change of the characteristic to the remote devices
+ /// Sends the notification for the value change of the characteristic to the remote devices.
/// </summary>
- /// <param name="characteristic">characteristic The characteristic which has a changed value</param>
- /// <param name="clientAddress">Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when service is not registered or when cccd is not enabled.</exception>
+ /// <param name="characteristic">The characteristic, which has a changed value.</param>
+ /// <param name="clientAddress">The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled.</exception>
public void SendNotification(BluetoothGattCharacteristic characteristic, string clientAddress)
{
_impl.SendNotification(characteristic, clientAddress);
}
/// <summary>
- /// Sends a response to the remote device as a result of a read/ write request
+ /// Sends a response to the remote device as a result of a read/write request.
/// </summary>
- /// <param name="requestId">The identification of a read/ write request</param>
- /// <param name="type">The request type for read/write</param>
- /// <param name="status">error value in case of failure, 0 for success</param>
- /// <param name="value">Value to be sent</param>
- /// <param name="offset">Fffset from where the value is read</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or send response procedure fails.</exception>
+ /// <param name="requestId">The identification of a read/write request.</param>
+ /// <param name="type">The request type for read/write.</param>
+ /// <param name="status">The error value in case of failure, 0 for success.</param>
+ /// <param name="value">The value to be sent.</param>
+ /// <param name="offset">The offset from where the value is read.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or the send response procedure fails.</exception>
public void SendResponse(int requestId, BluetoothGattRequestType type, int status, byte[] value, int offset)
{
_impl.SendResponse(requestId, (int)type, status, value, offset);
}
/// <summary>
- /// Bluetooth GATT client
+ /// The Bluetooth GATT client.
/// </summary>
public class BluetoothGattClient
{
}
/// <summary>
- /// Address of remote device.
+ /// The address of the remote device.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected.</exception>
public string RemoteAddress
{
get
}
/// <summary>
- /// Gets service with given UUID that belongs to the remote device.
+ /// Gets the service with the given UUID that belongs to the remote device.
/// </summary>
- /// <param name="uuid">UUID for the service to get</param>
- /// <returns>service with given uuid if it exists, null otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when get service fails.</exception>
+ /// <param name="uuid">The UUID for the service to get.</param>
+ /// <returns>The service with the given UUID if it exists, null otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when the get service fails.</exception>
public BluetoothGattService GetService(string uuid)
{
return _impl.GetService(this, uuid);
/// <summary>
/// Gets list of services that belongs to the remote device.
/// </summary>
- /// <returns>list of services that belongs to the remote device</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when get services fails.</exception>
+ /// <returns>The list of services that belongs to the remote device.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when the get service fails.</exception>
public IEnumerable<BluetoothGattService> GetServices()
{
return _impl.GetServices(this);
}
/// <summary>
- /// Reads the value of given characteristic from the remote device asynchronously.
+ /// Reads the value of a given characteristic from the remote device asynchronously.
/// </summary>
- /// <param name="characteristic">characteristic to be read</param>
- /// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when read attribute value fails.</exception>
+ /// <param name="characteristic">The characteristic to be read.</param>
+ /// <returns>true on success, false otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when the read attribute value fails.</exception>
public async Task<bool> ReadValueAsync(BluetoothGattCharacteristic characteristic)
{
return await _impl.ReadValueAsyncTask(characteristic.GetHandle());
}
/// <summary>
- /// Reads the value of given descriptor from the remote device asynchronously.
+ /// Reads the value of the given descriptor from the remote device asynchronously.
/// </summary>
- /// <param name="descriptor">descriptor to be read</param>
- /// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when read attribute value fails.</exception>
+ /// <param name="descriptor">The descriptor to be read.</param>
+ /// <returns>true on success, false otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when the read attribute value fails.</exception>
public async Task<bool> ReadValueAsync(BluetoothGattDescriptor descriptor)
{
return await _impl.ReadValueAsyncTask(descriptor.GetHandle());
}
/// <summary>
- /// Write value of given characteristic to remote device asynchronously.
+ /// Writes the value of a given characteristic to the remote device asynchronously.
/// </summary>
- /// <param name="characteristic">characteristic to be written</param>
- /// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when write attribute value fails.</exception>
+ /// <param name="characteristic">The characteristic to be written.</param>
+ /// <returns>true on success, false otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected or when the write attribute value fails.</exception>
public async Task<bool> WriteValueAsync(BluetoothGattCharacteristic characteristic)
{
return await _impl.WriteValueAsyncTask(characteristic.GetHandle());
}
/// <summary>
- /// Write value of given descriptor to remote device asynchronously.
+ /// Writes the value of the given descriptor to the remote device asynchronously.
/// </summary>
- /// <param name="descriptor">descriptor to be written</param>
- /// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled
- /// or when remote device is disconnected or when write attribute value fails.</exception>
+ /// <param name="descriptor">The descriptor to be written.</param>
+ /// <returns>true on success, false otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// or when the remote device is disconnected, or when the write attribute value fails.</exception>
public async Task<bool> WriteValueAsync(BluetoothGattDescriptor descriptor)
{
return await _impl.WriteValueAsyncTask(descriptor.GetHandle());
}
/// <summary>
- /// Bluetooth GATT service
+ /// The Bluetooth GATT service.
/// </summary>
public class BluetoothGattService
{
private BluetoothGattService _parentService = null;
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="uuid">UUID of the service</param>
- /// <param name="type">type of service</param>
- /// <exception cref="System.InvalidOperationException">Thrown create gatt service procedure fails.</exception>
+ /// <param name="uuid">The UUID of the service.</param>
+ /// <param name="type">The type of service.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the create GATT service procedure fails.</exception>
public BluetoothGattService(string uuid, BluetoothGattServiceType type)
{
Uuid = uuid;
}
/// <summary>
- /// Specification name from the UUID
+ /// Specification name from the UUID.
/// </summary>
public string Uuid { get; }
/// <summary>
- /// Adds a characteristic to this service
+ /// Adds a characteristic to this service.
/// </summary>
- /// <param name="characteristic">characteristic to be added</param>
- /// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown add gatt characteristic procedure fails.</exception>
+ /// <param name="characteristic">The characteristic to be added.</param>
+ /// <returns>true on success, false otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the add GATT characteristic procedure fails.</exception>
public void AddCharacteristic(BluetoothGattCharacteristic characteristic)
{
if (GetGattClient() != null)
}
/// <summary>
- /// Gets characteristic with given UUID that belongs to this service.
+ /// Gets the characteristic with the given UUID that belongs to this service.
/// </summary>
- /// <param name="uuid">UUID for the characteristic to get</param>
- /// <returns>characteristic with given uuid if it exists, null otherwise</returns>
+ /// <param name="uuid">The UUID for the characteristic to get.</param>
+ /// <returns>The characteristic with a given UUID if it exists, null otherwise.</returns>
public BluetoothGattCharacteristic GetCharacteristic(string uuid)
{
return _impl.GetCharacteristic(this, uuid);
}
/// <summary>
- /// Gets list of characteristic that belongs to this service.
+ /// Gets list of the characteristic that belongs to this service.
/// </summary>
- /// <returns>list of characteristic that belongs to this service</returns>
+ /// <returns>The list of the characteristic that belongs to this service.</returns>
public IEnumerable<BluetoothGattCharacteristic> GetCharacteristics()
{
return _impl.GetCharacteristics(this);
}
/// <summary>
- /// Includes a service to this service
+ /// Includes a service to this service.
/// </summary>
- /// <param name="service">service to be included</param>
+ /// <param name="service">The service to be included.</param>
/// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown add gatt service procedure fails.</exception>///
+ /// <exception cref="System.InvalidOperationException">Thrown when the add GATT service procedure fails.</exception>///
public void AddService(BluetoothGattService service)
{
if (GetGattClient() != null)
}
/// <summary>
- /// Gets included service
+ /// Gets the included service.
/// </summary>
- /// <param name="uuid">UUID for the service to get</param>
- /// <returns>service with given uuid if it exists, null otherwise</returns>
+ /// <param name="uuid">The UUID for the service to get.</param>
+ /// <returns>The service with a given UUID if it exists, null otherwise.</returns>
public BluetoothGattService GetIncludeService(string uuid)
{
return _impl.GetIncludeService(this, uuid);
}
/// <summary>
- /// Gets included service list of this service.
+ /// Gets the included service list of this service.
/// </summary>
- /// <returns>included service list of this service</returns>
+ /// <returns>The included service list of this service.</returns>
public IEnumerable<BluetoothGattService> GetIncludeServices()
{
return _impl.GetIncludeServices(this);
/// <summary>
/// Gets the server instance which the specified service belongs to.
/// </summary>
- /// <returns>server instance which the specified service belongs to</returns>
+ /// <returns>The server instance which the specified service belongs to.</returns>
public BluetoothGattServer GetGattServer()
{
return _parentServer;
/// <summary>
/// Gets the client instance which the specified service belongs to.
/// </summary>
- /// <returns>client instance which the specified service belongs to</returns>
+ /// <returns>The client instance which the specified service belongs to.</returns>
public BluetoothGattClient GetGattClient()
{
return _parentClient;
}
/// <summary>
- /// Bluetooth GATT characteristic
+ /// The Bluetooth GATT characteristic.
/// </summary>
public class BluetoothGattCharacteristic : BluetoothGattAttribute
{
internal EventHandler<NotificationStateChangedEventArg> _notificationStateChanged;
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="uuid">UUID of the characterstic</param>
- /// <param name="permissions">Permissions for the characterstic</param>
- /// <param name="properties">Properties set for the characterstic</param>
- /// <param name="value">Value associated with the characterstic</param>
- /// <remarks>throws in case of internal error</remarks>
- /// <exception cref="System.InvalidOperationException">Thrown create gatt characteristics procedure fails.</exception>
+ /// <param name="uuid">The UUID of the characterstic.param>
+ /// <param name="permissions">Permissions for the characterstic.</param>
+ /// <param name="properties">Properties set for the characterstic.</param>
+ /// <param name="value">The value associated with the characterstic.</param>
+ /// <remarks>throws in case of internal error.</remarks>
+ /// <exception cref="System.InvalidOperationException">Thrown when the create GATT characteristics procedure fails.</exception>
public BluetoothGattCharacteristic(string uuid, BluetoothGattPermission permissions, BluetoothGattProperty properties, byte[] value) : base(uuid, permissions)
{
_impl = new BluetoothGattCharacteristicImpl(uuid, permissions, properties, value);
}
/// <summary>
- /// (event) CharacteristicValueChanged is raised when server notifies for change in this characteristic value
+ /// The CharacteristicValueChanged event is raised when the server notifies for change in this characteristic value.
/// </summary>
/// <remarks>
- /// Adding event handle on charateristic on server side will not have any effect
+ /// Adding the event handle on characteristic on the server side will not have any effect.
/// </remarks>
public event EventHandler<ValueChangedEventArgs> ValueChanged
{
}
/// <summary>
- /// (event) NotificationStateChanged is called when client enables or disables the Notification/Indication for particular characteristics.
+ /// The NotificationStateChanged event is called when the client enables or disables the Notification/Indication for particular characteristics.
/// </summary>
/// <remarks>
- /// Adding event handle on charateristic on client side will not have any effect
+ /// Adding event handle on the characteristic on the client side will not have any effect.
/// </remarks>
public event EventHandler<NotificationStateChangedEventArg> NotificationStateChanged
{
}
/// <summary>
- /// Property for this characteristic
+ /// The property for this characteristic.
/// </summary>
public BluetoothGattProperty Properties
{
}
/// <summary>
- /// Write type to be used for write operations
+ /// The write type to be used for write operations.
/// </summary>
public BluetoothGattWriteType WriteType
{
}
/// <summary>
- /// Adds a descriptor to this characteristic
+ /// Adds a descriptor to this characteristic.
/// </summary>
- /// <param name="descriptor">descriptor to be added</param>
- /// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown add gatt descriptor procedure fails.</exception>
+ /// <param name="descriptor">The descriptor to be added.</param>
+ /// <returns>true on success, false otherwise.</returns>
+ /// <exception cref="System.InvalidOperationException">Thrown when the add GATT descriptor procedure fails.</exception>
public void AddDescriptor(BluetoothGattDescriptor descriptor)
{
if (Client != null)
}
/// <summary>
- /// Gets descriptor with given UUID that belongs to this characteristic.
+ /// Gets the descriptor with the given UUID that belongs to this characteristic.
/// </summary>
- /// <param name="uuid">UUID for the descriptor to get</param>
- /// <returns>descriptor with given uuid if it exists, null otherwise</returns>
+ /// <param name="uuid">The UUID for the descriptor to get.</param>
+ /// <returns>The descriptor with a given UUID if it exists, null otherwise.</returns>
public BluetoothGattDescriptor GetDescriptor(string uuid)
{
return _impl.GetDescriptor(this, uuid);
}
/// <summary>
- /// Gets list of descriptors that belongs to this characteristic.
+ /// Gets the list of descriptors that belongs to this characteristic.
/// </summary>
- /// <returns>list of descriptors that belongs to this characteristic</returns>
+ /// <returns>The list of descriptors that belongs to this characteristic.</returns>
public IEnumerable<BluetoothGattDescriptor> GetDescriptors()
{
return _impl.GetDescriptors(this);
}
/// <summary>
- /// Gets the service instance which the specified characterstic belongs to.
+ /// Gets the service instance, which the specified characterstic belongs to.
/// </summary>
- /// <returns>characteristic instance, the specified characterstic belongs to.</returns>
+ /// <returns>The characteristic instance, the specified characterstic belongs to.</returns>
public BluetoothGattService GetService()
{
return _parent;
}
/// <summary>
- /// Bluetooth GATT descriptor
+ /// The Bluetooth GATT descriptor.
/// </summary>
public class BluetoothGattDescriptor : BluetoothGattAttribute
{
private BluetoothGattDescriptorImpl _impl;
/// <summary>
- /// Constructor
+ /// The constructor.
/// </summary>
- /// <param name="uuid">UUID of the descriptor</param>
- /// <param name="permisions">Permissions for the descriptor</param>
- /// <param name="value">Value associated with the descriptor</param>
- /// <remarks>throws in case of internal error</remarks>
- /// <exception cref="System.InvalidOperationException">Thrown create gatt descriptor procedure fails.</exception>
+ /// <param name="uuid">The UUID of the descriptor.</param>
+ /// <param name="permisions">Permissions for the descriptor.</param>
+ /// <param name="value">The value associated with the descriptor.</param>
+ /// <remarks>throws in case of internal error.</remarks>
+ /// <exception cref="System.InvalidOperationException">Thrown when the create GATT descriptor procedure fails.</exception>
public BluetoothGattDescriptor(string uuid, BluetoothGattPermission permisions, byte[] value) : base (uuid, permisions)
{
_impl = new BluetoothGattDescriptorImpl(uuid, permisions, value);
}
/// <summary>
- /// Gets the characteristic instance which the specified descriptor belongs to.
+ /// Gets the characteristic instance, which the specified descriptor belongs to.
/// </summary>
- /// <returns>characteristic instance, the specified descriptor belongs to.</returns>
+ /// <returns>The characteristic instance, the specified descriptor belongs to.</returns>
public BluetoothGattCharacteristic GetCharacteristic()
{
return _parent;
}
/// <summary>
- /// Bluetooth GATT attribute
+ /// The Bluetooth GATT attribute.
/// </summary>
public abstract class BluetoothGattAttribute
{
// Events
/// <summary>
- /// Event called when client request to read value of a characteristic or descriptor
+ /// This event is called when the client request to read the value of a characteristic or a descriptor.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when set read value requested callback procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the set read value requested callback procedure fails.</exception>
public event EventHandler<ReadRequestedEventArgs> ReadRequested
{
add
}
/// <summary>
- /// Event called when a value of a characteristic or descriptor has been changed by a client
+ /// This event is called when a value of a characteristic or a descriptor has been changed by a client.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when set write value requested callback procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the set write value requested callback procedure fails.</exception>
public event EventHandler<WriteRequestedEventArgs> WriteRequested
{
add
}
/// <summary>
- /// Attribute's UUID
+ /// The attribute's UUID.
/// </summary>
public string Uuid { get; }
/// <summary>
- /// Permissions for this attribute
+ /// Permissions for this attribute.
/// </summary>
public BluetoothGattPermission Permissions { get; }
/// <summary>
- /// Value of this descriptor
+ /// The value of this descriptor.
/// </summary>
public byte[] Value
{
internal abstract BluetoothGattAttributeImpl Impl { get; }
/// <summary>
- /// Returns string value at specified offset
+ /// Returns a string value at the specified offset.
/// </summary>
/// <param name="offset"></param>
- /// <returns>string value at specified offset</returns>
+ /// <returns>The string value at specified offset.</returns>
public string GetValue(int offset)
{
return Impl.GetValue(offset);
}
/// <summary>
- /// Sets string value as specified offset
+ /// Sets the string value as a specified offset.
/// </summary>
/// <param name="value">value to set</param>
- /// <exception cref="InvalidOperationException">Throws excetion if value is null</exception>
+ /// <exception cref="InvalidOperationException">Throws exception if the value is null.</exception>
public void SetValue(string value)
{
if (string.IsNullOrEmpty(value))
}
/// <summary>
- /// Returns value at specified offset as int value of specified type
+ /// Returns a value at specified offset as the int value of the specified type.
/// </summary>
- /// <param name="type">type of int value</param>
- /// <param name="offset">offset in the attribute value buffer</param>
- /// <returns>int value at given offset</returns>
- /// <exception cref="InvalidOperationException">Throws excetion if (offset + size of int value) is greater then length of value buffer</exception>
+ /// <param name="type">The type of the int value.</param>
+ /// <param name="An offset">An offset in the attribute value buffer.</param>
+ /// <returns>The int value at given offset.</returns>
+ /// <exception cref="InvalidOperationException">Throws exception if (offset + size of int value) is greater than the length of the value buffer.</exception>
public int GetValue(IntDataType type, int offset)
{
return Impl.GetValue(type, offset);
}
/// <summary>
- /// Update Value at specified offset by int value of specified type
+ /// Updates a value at the specified offset by the int value of the specified type.
/// </summary>
- /// <param name="type">type of int value</param>
- /// <param name="value">value to set</param>
- /// <param name="offset">offset in the attribute value buffer</param>
- /// <exception cref="InvalidOperationException">Throws excetion if (offset + size of int value) is greater then length of value buffer</exception>
+ /// <param name="type">The type of the int value.</param>
+ /// <param name="value">The value to set.</param>
+ /// <param name="offset">An offset in the attribute value buffer.</param>
+ /// <exception cref="InvalidOperationException">Throws exception if (offset + size of int value) is greater than the length of the value buffer.</exception>
public void SetValue(IntDataType type, int value, int offset)
{
Impl.SetValue(type, value, offset);
}
/// <summary>
- /// Returns value at specified offset as float value of specified type
+ /// Returns a value at the specified offset as the float value of the specified type.
/// </summary>
- /// <param name="type">type of float value</param>
- /// <param name="offset">offset in the attribute value buffer</param>
- /// <returns>float value at given offset</returns>
- /// <exception cref="InvalidOperationException">Throws excetion if (offset + size of float value) is greater then length of value buffer</exception>
+ /// <param name="type">The type of the float value.</param>
+ /// <param name="offset">An offset in the attribute value buffer.</param>
+ /// <returns>The float value at given offset.</returns>
+ /// <exception cref="InvalidOperationException">Throws exception if (offset + size of float value) is greater than the length of the value buffer.</exception>
public float GetValue(FloatDataType type, int offset)
{
return Impl.GetValue(type, offset);
}
/// <summary>
- /// Update Value at specified offset by float value of specified type
+ /// Updates the value at the specified offset by the float value of the specified type.
/// </summary>
- /// <param name="type">type of float value</param>
- /// <param name="mantissa">mantissa of float value</param>
- /// <param name="exponent">exponent of float value</param>
- /// <param name="offset">offset in the attribute value buffer</param>
- /// <exception cref="InvalidOperationException">Throws excetion if (offset + size of float value) is greater then length of value buffer</exception>
+ /// <param name="type">The type of the float value.</param>
+ /// <param name="mantissa">The mantissa of the float value.</param>
+ /// <param name="exponent">An exponent of the float value.</param>
+ /// <param name="offset">An offset in the attribute value buffer.</param>
+ /// <exception cref="InvalidOperationException">Throws exception if (offset + size of float value) is greater than the length of the value buffer.</exception>
public void SetValue(FloatDataType type, int mantissa, int exponent, int offset)
{
Impl.SetValue(type, mantissa, exponent, offset);
}
/// <summary>
- /// (event) HidConnectionStateChanged is called when hid host connection state is changed.
+ /// The HidConnectionStateChanged event is called when the HID host connection state is changed.
/// </summary>
public event EventHandler<HidConnectionStateChangedEventArgs> HidConnectionStateChanged
{
}
/// <summary>
- /// Connect the remote device with the Hid service.
+ /// Connects the remote device with the HID service.
/// </summary>
/// <remarks>
- /// The device must be bonded with remote device by CreateBond().
- /// If connection request succeeds, HidConnectionStateChanged event will be invoked.
+ /// The device must be bonded with the remote device by CreateBond().
+ /// If connection request succeeds, the HidConnectionStateChanged event will be invoked.
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when connection attempt to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the connection attempt to the remote device fails.</exception>
public void Connect()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Disconnects the remote device with the Hid service.
+ /// Disconnects the remote device with the HID service.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when disconnection attempt to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the disconnection attempt to the remote device fails.</exception>
public void Disconnect()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
namespace Tizen.Network.Bluetooth {
/// <summary>
- /// This class is BluetoothLeAdvertiser. Handles the Le Advertising operation amd callback.
+ /// This is the BluetoothLeAdvertiser class. It handles the LE advertising operation amd callback.
/// </summary>
public class BluetoothLeAdvertiser
{
}
/// <summary>
- /// Event that is called when the LE advertising state changes
+ /// This event is called when the LE advertising state changes.
/// </summary>
public event EventHandler<AdvertisingStateChangedEventArgs> AdvertisingStateChanged
{
}
}
/// <summary>
- /// Start advertising using the advertisedata object.
+ /// Starts advertising using the advertise data object.
/// </summary>
/// <remarks>
- /// Bluetooth must be enabled.
+ /// The Bluetooth must be enabled.
/// </remarks>
/// <param name="advertiseData">The advertiser object carrying information of the advertising.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public void StartAdvertising(BluetoothLeAdvertiseData advertiseData)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// Stops the advertising.
/// </summary>
/// <remarks>
- /// Bluetooth must be enabled.
+ /// The Bluetooth must be enabled.
/// </remarks>
/// <param name="advertiseData">The advertiser object carrying information of the advertising.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public void StopAdvertising(BluetoothLeAdvertiseData advertiseData)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// This class is BluetoothLeDevice.
- /// Handles the Le device operations like getting data from the scan result information.
+ /// This is the BluetoothLeDevice class.
+ /// It handles the LE device operations like getting data from the scan result information.
/// </summary>
public class BluetoothLeDevice
{
private BluetoothLeScanData _scanData;
/// <summary>
- /// Event that is called when the Gatt client connects/disconnects with the server
+ /// This event is called when the GATT client connects/disconnects with the server.
/// </summary>
public event EventHandler<GattConnectionStateChangedEventArgs> GattConnectionStateChanged
{
}
/// <summary>
- /// Get service uuids list from the Le scan result information
+ /// Gets the service UUIDs list from the LE scan result information.
/// </summary>
- /// <value> Gets list of string service uuids.</value>
+ /// <value> Gets the list of the string service UUIDs.</value>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public IEnumerable<string> ServiceUuid
{
get
}
/// <summary>
- /// Get device name from the Le scan result information
+ /// Gets the device name from the LE scan result information.
/// </summary>
- /// <value> Gets device name.</value>
+ /// <value> Gets the device name.</value>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public string DeviceName
{
get
}
}
/// <summary>
- /// Get transmission power level from the Le scan result information
+ /// Gets the transmission power level from the LE scan result information.
/// </summary>
/// <value> Gets the transmission power level in dB.</value>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public int TxPowerLevel
{
get
}
/// <summary>
- /// Get service solicitation uuid list from the scan result information
+ /// Gets the service solicitation UUID list from the scan result information.
/// </summary>
- /// <value> Gets list of service solicitation uuids.</value>
+ /// <value> Gets the list of the service solicitation UUIDs.</value>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public IEnumerable<string> ServiceSolictationUuid
{
get
}
}
/// <summary>
- /// Gets the manufacturer data from the scan result information
+ /// Gets the manufacturer data from the scan result information.
/// </summary>
/// <value> Gets the appearance value.</value>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public int Appearance
{
get
}
}
/// <summary>
- /// Gets the manufacturer data from the scan result information
+ /// Gets the manufacturer data from the scan result information.
/// </summary>
- /// <value> Gets the manufacturer data containing the manucturer data and id information.</value>
+ /// <value> Gets the manufacturer data containing the manucturer data and ID information.</value>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>///
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>///
public ManufacturerData ManufacturerData
{
get
}
/// <summary>
- /// Get service data list from the scan result information
+ /// Gets the service data list from the scan result information.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <returns> Returns the service data list.</returns>
+ /// <returns> Returns the service data list.</returns>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public IEnumerable<BluetoothLeServiceData> GetServiceDataList()
{
int serviceCount = 0;
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="autoConnect"> The auto connect flag</param>
+ /// <param name="autoConnect"> The auto connect flag.</param>
/// <returns>client instance</returns>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when gatt connection attempt to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the gatt connection attempt to remote device fails.</exception>
public BluetoothGattClient GattConnect(bool autoConnect)
{
BluetoothGattClient client = null;
}
/// <summary>
- /// Disconnect a GATT connection with the remote device.
+ /// Disconnects a GATT connection with the remote device.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when gatt disconnection attempt to remote device fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the gatt disconnection attempt to remote device fails.</exception>
public void GattDisconnect()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Bluetooth le advertise data. Handles the data advertising.
+ /// Bluetooth LE advertise data. Handles the data advertising.
/// </summary>
public class BluetoothLeAdvertiseData:IDisposable
{
private bool _includeDeviceName;
/// <summary>
- /// Default Constructor.Initializes an object of BluetoothLeAdvertiseData
+ /// The default constructor initializes an object of the BluetoothLeAdvertiseData.
/// </summary>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when create advertiser fails.</exception>
public BluetoothLeAdvertiseData()
{
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when set advertising mode fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the set advertising mode fails.</exception>
public BluetoothLeAdvertisingMode AdvertisingMode
{
get
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when set advertising connectable mode fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the set advertising connectable mode fails.</exception>
public bool AdvertisingConnectable
{
get
}
}
/// <summary>
- /// Sets the external appearance of this device to advertise or scan response data
- /// Please refer to the adopted Bluetooth specification for the the 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.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when set appearance fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the set appearance fails.</exception>
public int Appearance
{
get
}
}
/// <summary>
- /// Sets whether the device name has to be incuded in the advertise or scan response data
- /// The maximum advertised or responded data size is 31 bytes including data type and system wide data.
+ /// 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.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when set advertising device name fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the set advertising device name fails.</exception>
public bool IncludeDeviceName
{
get
/// <summary>
- /// Set whether the transmission power level should be included in advertise or scan response data.
- /// The maximum advertised or responded data size is 31 bytes including data type and system wide data.
+ /// 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.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when set advertising TC power level fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the set advertising TC power level fails.</exception>
public bool IncludeTxPowerLevel
{
get
}
}
/// <summary>
- /// Add a service UUID to advertise or scan response data.
+ /// Adds a service UUID 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
+ /// including the data type and the system wide data.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="packetType">The packet type </param>
- /// <param name="serviceUuid"> The service uuid to add to advertise data</param>
+ /// <param name="packetType">The packet type.</param>
+ /// <param name="serviceUuid"> The service UUID to add to advertise data.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when add advertising service uuid procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the add advertising service UUID procedure fails.</exception>
public void AddAdvertisingServiceUuid(BluetoothLePacketType packetType, string serviceUuid)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Add a service solicitation UUID to advertise or scan response data.
+ /// Adds a service solicitation UUID to advertise or scan the response data.
/// The maximum advertised or responded data size is 31 bytes
- /// including data type and system wide data.
+ /// including the data type and the system wide data.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="packetType">The packet type </param>
- /// <param name="serviceSolicitationUuid"> The service solicitation uuid to add to advertise data</param>
+ /// <param name="packetType">The packet type.</param>
+ /// <param name="serviceSolicitationUuid"> The service solicitation UUID to add to advertise data.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when add advertising service solicitation uuid procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the add advertising service solicitation UUID procedure fails.</exception>
public void AddAdvertisingServiceSolicitationUuid(BluetoothLePacketType packetType,
string serviceSolicitationUuid)
{
}
/// <summary>
- /// Add a service data to advertise or scan response data.
+ /// 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.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="packetType">The packet type </param>
- /// <param name="data"> The service data to be added to advertising</param>
+ /// <param name="packetType">The packet type.</param>
+ /// <param name="data"> The service data to be added to advertising.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when add advertising data procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the add advertising data procedure fails.</exception>
public void AddAdvertisingServiceData(BluetoothLePacketType packetType, BluetoothServiceData data)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
/// <summary>
- /// Add manufacturer specific data to advertise or scan response data.
- /// Please refer to the adopted Bluetooth specification for the the appearance..
+ /// Adds the manufacturer specific data to the advertise or the scan response data.
+ /// Please refer to the adopted Bluetooth specification for the the appearance.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="packetType">The packet type</param>
- /// <param name="manufacturerData"> The manufacturer specific data</param>
+ /// <param name="packetType">The packet type.</param>
+ /// <param name="manufacturerData"> The manufacturer specific data.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when add advertising manufacturer data procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the add advertising manufacturer data procedure fails.</exception>
public void AddAdvertisingManufacturerData(BluetoothLePacketType packetType,
ManufacturerData manufacturerData)
{
}
/// <summary>
- /// Clear all data to be advertised or responded to scan request from LE scanning device.
+ /// Clears all data to be advertised or responded to the scan request from the LE scanning device.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
/// </remarks>
- /// <param name="packetType">The packet type to be cleared</param>
+ /// <param name="packetType">The packet type to be cleared.</param>
/// <exception cref="System.NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not Enabled
- /// or when clear advertising data procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth LE is not enabled
+ /// or when the clear advertising data procedure fails.</exception>
internal void ClearAdvertisingData(BluetoothLePacketType packetType)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// A generic class to represent all Bluetooth profiles.<br>
- /// Any common properties/functions to be added in this class in future.
+ /// This generic class represents all Bluetooth profiles.<br>
+ /// Any common properties/functions can be added in this class in future.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
public abstract class BluetoothProfile
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// BluetoothSocket provides functions for managing connections to other devices and exchanging data.
+ /// The BluetoothSocket provides functions for managing connections to other devices and exchanging data.
/// </summary>
public class BluetoothServerSocket : IDisposable
{
private bool disposed = false;
/// <summary>
- /// (event) AcceptStateChanged is raised when socket connection state is changed.
+ /// The AcceptStateChanged event is raised when the socket connection state is changed.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when register accpet state changed callback fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the register accpet state changed callback fails.</exception>
public event EventHandler<AcceptStateChangedEventArgs> AcceptStateChanged
{
add
}
/// <summary>
- /// Starts listening on passed rfcomm socket and accepts connection requests.
+ /// Starts listening on the passed RFCOMM socket and accepts connection requests.
/// </summary>
/// <remarks>
- /// The socket must be created with CreateServerSocket(). This API invokes ConnectionStateChanged event.
+ /// The socket must be created with CreateServerSocket(). This API invokes the ConnectionStateChanged event.
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when listen on socket procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the listen on socket procedure fails.</exception>
public void Listen()
{
int ret = Interop.Bluetooth.Listen(socketFd, 1);
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// IBluetoothServerSocket interface. Handles the server socket operations.
+ /// The IBluetoothServerSocket interface handles the server socket operations.
/// </summary>
public interface IBluetoothServerSocket
{
}
/// <summary>
- /// IBluetoothClientSocket interface. Handles the client socket operations.
+ /// The IBluetoothClientSocket interface handles the client socket operations.
/// </summary>
public interface IBluetoothClientSocket : IBluetoothServerSocket
{
internal string serviceUuid;
/// <summary>
- /// This event occurs when socket server received data from client.
+ /// This event occurs when the socket server receives data from the client.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when register data received callback fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the register data received callback fails.</exception>
public event EventHandler<SocketDataReceivedEventArgs> DataReceived
{
add
}
/// <summary>
- /// This event occurs when connection state between two devices is changed.
+ /// This event occurs when the connection state between two devices is changed.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when register connection changed callback fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the register connection changed callback fails.</exception>
public event EventHandler<SocketConnectionStateChangedEventArgs> ConnectionStateChanged
{
add
/// Connects to a specific RFCOMM based service on a remote Bluetooth device UUID.
/// </summary>
/// <remarks>
- /// The bluetooth must be enabled, discoverable with StartDiscovery(), bonded with the remote device using CreateBond(). ConnectionStateChanged event is raised once this API is called.
+ /// The bluetooth must be enabled, discoverable with StartDiscovery(), and bonded with the remote device using CreateBond(). The ConnectionStateChanged event is raised once this API is called.
/// </remarks>
/// <param name="address">The address of the remote Bluetooth device.</param>
- /// <param name="serviceUuid">The UUID of service provided by the remote Bluetooth device.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when connect socket attempt to remote device fails or when the service uuid is not supported by the remote device.</exception>
+ /// <param name="serviceUuid">The UUID of the service provided by the remote Bluetooth device.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the connect socket attempt to remote device fails, or when the service UUID is not supported by the remote device.</exception>
void IBluetoothClientSocket.Connect()
{
int ret = Interop.Bluetooth.ConnectSocket(remoteAddress, serviceUuid);
}
/// <summary>
- /// Disconnects the RFCOMM connection with the given file descriptor of conneted socket.
+ /// Disconnects the RFCOMM connection with the given file descriptor of the conneted socket.
/// </summary>
/// <remarks>
/// The connection must be established.
/// </remarks>
- /// <param name="socketFd">The file descriptor of socket to close.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when socket disconnect to remote device fails.</exception>
+ /// <param name="socketFd">The file descriptor of the socket to close.</param>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the socket disconnect to remote device fails.</exception>
void IBluetoothClientSocket.Disconnect()
{
int ret = Interop.Bluetooth.DisconnectSocket(connectedSocket);
/// <remarks>
/// The connection must be established.
/// </remarks>
- /// <param name="socketFd">The file descriptor of connected socket.</param>
+ /// <param name="socketFd">The file descriptor of the connected socket.</param>
/// <param name="data">The data to be sent.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not Enabled
- /// or when remote device is not connected or send data procedure fails.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// or when the remote device is not connected, or the send data procedure fails.</exception>
public int SendData(string data)
{
int ret = Interop.Bluetooth.SendData(connectedSocket, data, data.Length);
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// Structure of device class type and service.
+ /// The structure of the device class type and service.
/// </summary>
[StructLayout(LayoutKind.Sequential)]
internal struct BluetoothClassStruct
{
/// <summary>
- /// Type of the major device class.
+ /// The type of the major device class.
/// </summary>
internal BluetoothMajorDeviceClassType MajorDeviceClassType;
/// <summary>
- /// Type of the minor device class.
+ /// The type of the minor device class.
/// </summary>
internal BluetoothMinorDeviceClassType MinorDeviceClassType;
/// <summary>
- /// Major service class mask.
+ /// The major service class mask.
/// </summary>
internal int MajorServiceClassMask;
}
/// <summary>
- /// Structure containing the information of Bluetooth device.
+ /// This structure contains the information of the Bluetooth device.
/// </summary>
[StructLayout(LayoutKind.Sequential)]
internal struct BluetoothDeviceStruct
{
/// <summary>
- /// Address of device.
+ /// The address of the device.
/// </summary>
[MarshalAsAttribute(UnmanagedType.LPStr)]
internal string Address;
/// <summary>
- /// Name of device.
+ /// The name of the device.
/// </summary>
[MarshalAsAttribute(UnmanagedType.LPStr)]
internal string Name;
/// <summary>
- /// Class of device.
+ /// The class of the device.
/// </summary>
internal BluetoothClassStruct Class;
/// <summary>
- /// Service UUID list of device.
+ /// The service UUID list of the device.
/// </summary>
internal IntPtr ServiceUuidList;
/// <summary>
- /// Service count of device.
+ /// The service count of the device.
/// </summary>
internal int ServiceCount;
/// <summary>
- /// The paired state of device.
+ /// The paired state of the device.
/// </summary>
[MarshalAsAttribute(UnmanagedType.I1)]
internal bool IsPaired;
/// <summary>
- /// The connection state of device.
+ /// The connection state of the device.
/// </summary>
[MarshalAsAttribute(UnmanagedType.I1)]
internal bool IsConnected;
/// <summary>
- /// The authorization state of device.
+ /// The authorization state of the device.
/// </summary>
[MarshalAsAttribute(UnmanagedType.I1)]
internal bool IsAuthorized;
/// <summary>
- /// The length of the manufacturer data.
+ /// The length of the manufacturer the data.
/// </summary>
internal int ManufacturerDataLength;
internal struct BluetoothLeServiceDataStruct
{
/// <summary>
- /// Bluetooth Le service uuid.
+ /// The Bluetooth LE service UUID.
/// </summary>
[MarshalAs(UnmanagedType.LPStr)]
internal string ServiceUuid;
/// <summary>
- /// Bluetooth Le service data
+ /// The Bluetooth LE service data.
/// </summary>
internal IntPtr ServiceData;
projects / platform / core / csapi / tizenfx.git / commitdiff