/// <summary>
/// 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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public bool IsBluetoothEnabled
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public string Address
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public string Name
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public VisibilityMode Visibility
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public bool IsDiscoveryInProgress
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public int RemainingTimeAsVisible
{
get
/// <summary>
/// The StateChanged event is raised when the Bluetooth adapter state is changed.
/// </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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public event EventHandler<StateChangedEventArgs> StateChanged
{
add
/// <summary>
/// The NameChanged event is raised when the Bluetooth adapter name is changed.
/// </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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public event EventHandler<NameChangedEventArgs> NameChanged
{
add
/// <summary>
/// The VisibilityModeChanged event is raised when the Bluetooth adapter visibility mode is changed.
/// </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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public event EventHandler<VisibilityModeChangedEventArgs> VisibilityModeChanged
{
add
/// <summary>
/// The VisibilityDurationChanged event is raised very second until the visibility mode is changed to NonDiscoverable.
/// </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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public event EventHandler<VisibilityDurationChangedEventArgs> VisibilityDurationChanged
{
add
/// <summary>
/// The DiscoveryStateChanged event is raised when the device discovery state is changed.
/// </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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public event EventHandler<DiscoveryStateChangedEventArgs> DiscoveryStateChanged
{
add
/// <summary>
/// This event is called when the LE scan result is obtained.
/// </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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public event EventHandler<AdapterLeScanResultChangedEventArgs> ScanResultChanged
{
add
/// 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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or the start discovery fails.</exception>
static public void StartDiscovery()
{
/// 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 or
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled or
/// the discovery process is not is progress. </exception>
static public void StopDiscovery()
{
/// The Bluetooth must be enabled.
/// </remarks>
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or reading the Bonded devices list is failed.</exception>
static public IEnumerable<BluetoothDevice> GetBondedDevices()
{
/// The Bluetooth must be enabled.
/// </remarks>
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or reading the bonded device information fails.</exception>
static public BluetoothDevice GetBondedDevice(string address)
{
/// </summary>
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.</exception>
static public bool IsServiceUsed(string serviceUuid)
{
try
/// 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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or the read OObData procedure is failed.</exception>
static public BluetoothOobData GetLocalOobData()
{
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or the set OobData procedure is failed.</exception>
static public void SetRemoteOobData(string address, BluetoothOobData oobData)
{
/// The Bluetooth must be enabled.
/// </remarks>
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled.
/// or if the Remove Oobdata procedure is failed.</exception>
static public void RemoveRemoteOobData(string address)
{
/// <remarks>
/// 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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or the Start LE scan is failed.</exception>
static public void StartLeScan()
{
/// <remarks>
/// The Bluetooth must be enabled.
/// </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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or the Stop LE scan is failed.</exception>
static public void StopLeScan()
{
/// </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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or the socket create error occurs.</exception>
static public BluetoothServerSocket CreateServerSocket(string serviceUuid)
{
/// 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 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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or the socket destroy error occurs.</exception>
static public void DestroyServerSocket(BluetoothServerSocket socket)
{
/// and AdvancedAudioDistribution is connected.
/// </remarks>
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the connection attempt fails.</exception>
public void Connect(BluetoothAudioProfileType profileType)
{
/// and AdvancedAudioDistribution is disconnected.
/// </remarks>
/// <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="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when Disconnection attempt fails.</exception>
public void Disconnect(BluetoothAudioProfileType type)
{
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
{
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
{
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
{
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
{
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
{
/// The remote device must be connected.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
+ /// <exception cref="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)
{
/// 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
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the create bonding process to the remote device fails.</exception>
public void CreateBond()
{
/// <remarks>
/// Bonding must be in progress by CreateBond().
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the cancel bonding procedure to remote device fails.</exception>
public void CancelBonding()
{
/// The Bluetooth must be enabled and the bond must be created by CreateBond().
/// If this succeeds, the BondDestroyed event will be invoked.
/// </remarks>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the destroy bonding procedure fails.</exception>
public void DestroyBond()
{
/// The Bluetooth must be enabled and the bond must be created by CreateBond().
/// </remarks>
/// <param name="aliasName">The alias name of the remote device.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="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 this succeeds, the AuthorizationChanged event will be invoked.
/// </remarks>
/// <param name="authorizationState">The authorization state.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the set authorization to remote device fails.</exception>
public void SetAuthorization(BluetoothAuthorizationType authorizationState)
{
/// </summary>
/// <returns>The service mask list converted from the given UUID list.</returns>
/// <param name="uuids">The UUID list of the device.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the get Mask from UUID fails.</exception>
public BluetoothServiceClassType GetMaskFromUuid(string[] uuids)
{
/// 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
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the remote device service search fails.</exception>
public void StartServiceSearch()
{
/// 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="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when there is no BT connection.</exception>
public IEnumerable<BluetoothProfileType> GetConnectedProfiles()
{
/// </remarks>
/// <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
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when there is no BT connection.</exception>
public bool IsProfileConnected(BluetoothProfileType profileType)
{
/// <summary>
/// Exceptions for Bluetooth Errors.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth Error happens.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth Error happens.</exception>
static internal void ThrowBluetoothException(int exception)
{
BluetoothError error = (BluetoothError)exception;
/// 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 the create GATT server fails.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
+ /// <exception cref="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.
/// </summary>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the register server application fails.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the register server application fails.</exception>
public void Start()
{
_impl.Start();
/// Registers a specified service to this server.
/// </summary>
/// <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 the register service fails.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the register service fails.</exception>
public void RegisterGattService(BluetoothGattService service)
{
if (service.IsRegistered())
/// <remarks>
/// 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 the unregister service fails.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the unregister service fails.</exception>
public void UnregisterGattService(BluetoothGattService service)
{
if (service.GetGattServer() != this)
/// <remarks>
/// 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 the unregister all services fail.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the unregister all services fail.</exception>
public void UnregisterGattServices()
{
_impl.UnregisterAllGattServices(this);
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// <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
+ /// <exception cref="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)
{
/// <summary>
/// The address of the remote device.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not enabled
/// or when the remote device is disconnected.</exception>
public string RemoteAddress
{
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// Gets list of services that belongs to the remote device.
/// </summary>
/// <returns>The list of services that belongs to the remote device.</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not enabled
+ /// <exception cref="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()
{
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// </summary>
/// <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
+ /// <exception cref="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)
{
/// </summary>
/// <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>
+ /// <exception cref="InvalidOperationException">Thrown when the create GATT service procedure fails.</exception>
public BluetoothGattService(string uuid, BluetoothGattServiceType type)
{
Uuid = uuid;
/// </summary>
/// <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>
+ /// <exception cref="InvalidOperationException">Thrown when the add GATT characteristic procedure fails.</exception>
public void AddCharacteristic(BluetoothGattCharacteristic characteristic)
{
if (GetGattClient() != null)
/// </summary>
/// <param name="service">The service to be included.</param>
/// <returns>true on success, false otherwise</returns>
- /// <exception cref="System.InvalidOperationException">Thrown when the add GATT service procedure fails.</exception>///
+ /// <exception cref="InvalidOperationException">Thrown when the add GATT service procedure fails.</exception>///
public void AddService(BluetoothGattService service)
{
if (GetGattClient() != null)
/// <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>
+ /// <exception cref="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>
/// <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>
+ /// <exception cref="InvalidOperationException">Thrown when the add GATT descriptor procedure fails.</exception>
public void AddDescriptor(BluetoothGattDescriptor descriptor)
{
if (Client != null)
/// <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>
+ /// <exception cref="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>
/// 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 the set read value requested callback procedure fails.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the set read value requested callback procedure fails.</exception>
public event EventHandler<ReadRequestedEventArgs> ReadRequested
{
add
/// <summary>
/// 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 the set write value requested callback procedure fails.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the set write value requested callback procedure fails.</exception>
public event EventHandler<WriteRequestedEventArgs> WriteRequested
{
add
/// Returns a value at specified offset as the int value of the specified type.
/// </summary>
/// <param name="type">The type of the int value.</param>
- /// <param name="An offset">An offset in the attribute value buffer.</param>
+ /// <param name="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)
/// 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
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the connection attempt to the remote device fails.</exception>
public void Connect()
{
/// <summary>
/// Disconnects the remote device with the HID service.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the disconnection attempt to the remote device fails.</exception>
public void Disconnect()
{
/// 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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public void StartAdvertising(BluetoothLeAdvertiseData advertiseData)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// 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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public void StopAdvertising(BluetoothLeAdvertiseData advertiseData)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public IEnumerable<string> ServiceUuid
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public string DeviceName
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public int TxPowerLevel
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public IEnumerable<string> ServiceSolictationUuid
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public int Appearance
{
get
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>///
public ManufacturerData ManufacturerData
{
get
/// The Bluetooth must be enabled.
/// </remarks>
/// <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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled.</exception>
public IEnumerable<BluetoothLeServiceData> GetServiceDataList()
{
int serviceCount = 0;
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="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)
{
/// <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 cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the GATT disconnection attempt to remote device fails.</exception>
public void GattDisconnect()
{
/// <summary>
/// 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="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when create advertiser fails.</exception>
public BluetoothLeAdvertiseData()
{
/// <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 cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the set advertising mode fails.</exception>
public BluetoothLeAdvertisingMode AdvertisingMode
{
/// <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 cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the set advertising connectable mode fails.</exception>
public bool AdvertisingConnectable
{
/// <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 cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the set appearance fails.</exception>
public int Appearance
{
/// <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 cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the set advertising device name fails.</exception>
public bool IncludeDeviceName
{
/// <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 cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the set advertising TC power level fails.</exception>
public bool IncludeTxPowerLevel
{
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="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)
{
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="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)
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="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)
{
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="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)
/// The Bluetooth must be enabled.
/// </remarks>
/// <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
+ /// <exception cref="NotSupportedException">Thrown when the Bluetooth LE is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth LE is not enabled
/// or when the clear advertising data procedure fails.</exception>
internal void ClearAdvertisingData(BluetoothLePacketType packetType)
{
/// </remarks>
/// <param name="FilePath"> Path to store the files.</param>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public static BluetoothOppServer StartServer(string FilePath)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// Stops the Opp Server.
/// </summary>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void StopServer()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// </summary>
/// <param name="FileName"> File name to accept.</param>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public int AcceptPush(string FileName)
{
int _transitionId = -1;
/// Reject File Push request.
/// </summary>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void RejectPush()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// </summary>
/// <param name="TransferId"> tranfer ID.</param>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void CancelTransfer(int TransferId)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// </summary>
/// <param name="FilePath"> Path to store the files.</param>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void SetDestinationPath(string FilePath)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// </summary>
/// <param name="FilePath"> file for sending.</param>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void AddFile(string FilePath)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// Clears all the File paths.
/// </summary>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void ClearFiles()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// Cancels the ongoing push session.
/// </summary>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void CancelPush()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// </summary>
/// <param name="Destination"> destination device address.</param>
/// <feature>http://tizen.org/feature/network.bluetooth.opp</feature>
- /// <exception cref="System.NotSupportedException">Thrown when the required feature is not Supported.</exception>
- /// <exception cref="System.NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the required feature is not Supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the BT/BTLE is not Supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors.</exception>
public void PushFile(string Destination)
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
/// <summary>
/// The AcceptStateChanged event is raised when the socket connection state is changed.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the register accpet state changed callback fails.</exception>
public event EventHandler<AcceptStateChangedEventArgs> AcceptStateChanged
{
/// <remarks>
/// 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
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the listen on socket procedure fails.</exception>
public void Listen()
{
/// <summary>
/// This event occurs when the socket server receives data from the client.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the register data received callback fails.</exception>
public event EventHandler<SocketDataReceivedEventArgs> DataReceived
{
/// <summary>
/// This event occurs when the connection state between two devices is changed.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the register connection changed callback fails.</exception>
public event EventHandler<SocketConnectionStateChangedEventArgs> ConnectionStateChanged
{
/// <remarks>
/// 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 the service provided by the remote Bluetooth device.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// <exception cref="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()
{
/// <remarks>
/// The connection must be established.
/// </remarks>
- /// <param name="socketFd">The file descriptor of the socket to close.</param>
- /// <exception cref="System.InvalidOperationException">Thrown when the Bluetooth is not enabled
+ /// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
/// or when the socket disconnect to remote device fails.</exception>
void IBluetoothClientSocket.Disconnect()
{
/// <remarks>
/// The connection must be established.
/// </remarks>
- /// <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
+ /// <exception cref="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)
{
internal string ManufacturerData;
}
+ [StructLayout(LayoutKind.Sequential)]
internal struct BluetoothDeviceSdpStruct
{
[MarshalAsAttribute(UnmanagedType.LPStr)]
internal int ServiceCount;
}
+ [StructLayout(LayoutKind.Sequential)]
internal struct BluetoothDeviceConnectionStruct
{
internal string Address;
internal BluetoothDisconnectReason DisconnectReason;
}
+ [StructLayout(LayoutKind.Sequential)]
internal struct SocketDataStruct
{
internal int SocketFd;
internal IntPtr Data;
}
+ [StructLayout(LayoutKind.Sequential)]
internal struct SocketConnectionStruct
{
internal int SocketFd;