1402 lines
67 KiB
XML
1402 lines
67 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>InTheHand.Devices.Bluetooth</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothAdapter">
|
|
<summary>
|
|
Represents a local Bluetooth adapter.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothAdapter.BluetoothAddress">
|
|
<summary>
|
|
Gets the device address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothAdapter.IsClassicSupported">
|
|
<summary>
|
|
Gets a boolean indicating if the adapter supports the Bluetooth Classic transport type.
|
|
</summary>
|
|
<remarks>Always returns false for iOS, macOS and tvOS.</remarks>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothAdapter.IsLowEnergySupported">
|
|
<summary>
|
|
Gets a boolean indicating if the adapater supports Low Energy Bluetooth Transport type.
|
|
</summary>
|
|
<remarks>Always returns false for Windows Desktop.</remarks>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothAdapter.Name">
|
|
<summary>
|
|
Gets the Name of the adapter.
|
|
</summary>
|
|
<value>The name of the adapter.</value>
|
|
<remarks>On most platforms this is not separately editable from the machine name.</remarks>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothCacheMode">
|
|
<summary>
|
|
Indicates whether certain Bluetooth API methods should operate on values cached in the system or retrieve those values from the Bluetooth device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothCacheMode.Cached">
|
|
<summary>
|
|
Use system-cached values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothCacheMode.Uncached">
|
|
<summary>
|
|
Retrieve values from the Bluetooth device.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice">
|
|
<summary>
|
|
Provides functionality to determine the Bluetooth Class Of Device (Bluetooth COD) information for a device.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
|
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
<seealso cref="!:InTheHand.Net.Bluetooth.ClassOfDevice"/>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.FromRawValue(System.UInt32)">
|
|
<summary>
|
|
Creates a BluetoothClassOfDevice object from a raw integer value representing the Major Class, Minor Class and Service Capabilities of the device.
|
|
</summary>
|
|
<param name="rawValue">The raw integer value from which to create the BluetoothClassOfDevice object.</param>
|
|
<returns>A BluetoothClassOfDevice object.</returns>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.RawValue">
|
|
<summary>
|
|
Gets the Bluetooth Class Of Device information, represented as an integer value.
|
|
</summary>
|
|
<value>The Bluetooth Class Of Device information, represented as a raw integer value.</value>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.MajorClass">
|
|
<summary>
|
|
Gets the Major Class code of the Bluetooth device.
|
|
</summary>
|
|
<value>One of the enumeration values that specifies the device's Major Class code.</value>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.MinorClass">
|
|
<summary>
|
|
Gets the Minor Class code of the Bluetooth device.
|
|
</summary>
|
|
<value>One of the enumeration values that specifies the device's Minor Class code.</value>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.ServiceCapabilities">
|
|
<summary>
|
|
Gets the service capabilities of the device.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.GetHashCode">
|
|
<summary>
|
|
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.Equals(System.Object)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="obj"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothClassOfDevice.ToString">
|
|
<summary>
|
|
Returns the Major/Minor device class as a string.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothConnectionStatus">
|
|
<summary>
|
|
Indicates the connection status of the device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothConnectionStatus.Disconnected">
|
|
<summary>
|
|
The device is disconnected.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothConnectionStatus.Connected">
|
|
<summary>
|
|
The device is connected.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothDevice">
|
|
<summary>
|
|
Represents a Bluetooth device.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
|
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothDevice.GetDeviceSelector">
|
|
<summary>
|
|
Gets an Advanced Query Syntax (AQS) string for identifying all Bluetooth devices.
|
|
This string is passed to the <see cref="!:DeviceInformation.FindAllAsync"/> or CreateWatcher method in order to get a list of Bluetooth devices.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromClassOfDevice(InTheHand.Devices.Bluetooth.BluetoothClassOfDevice)">
|
|
<summary>
|
|
Creates an Advanced Query Syntax (AQS) filter string from a BluetoothClassOfDevice object.
|
|
The AQS string is passed into the CreateWatcher method to return a collection of DeviceInformation objects.
|
|
</summary>
|
|
<param name="classOfDevice">The class of device used for constructing the AQS string.</param>
|
|
<returns>An AQS string that can be passed as a parameter to the CreateWatcher method.</returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothDevice.GetDeviceSelectorFromPairingState(System.Boolean)">
|
|
<summary>
|
|
Creates an Advanced Query Syntax (AQS) filter string that contains a query for Bluetooth devices that are either paired or unpaired.
|
|
The AQS string is passed into the CreateWatcher method to return a collection of <see cref="T:InTheHand.Devices.Enumeration.DeviceInformation"/> objects.
|
|
</summary>
|
|
<param name="pairingState">The current pairing state for Bluetooth devices used for constructing the AQS string.
|
|
Bluetooth devices can be either paired (true) or unpaired (false).
|
|
The AQS Filter string will request scanning to be performed when the pairingState is false.</param>
|
|
<returns>An AQS string that can be passed as a parameter to the CreateWatcher method.</returns>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothDevice.BluetoothAddress">
|
|
<summary>
|
|
Gets the device address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothDevice.ClassOfDevice">
|
|
<summary>
|
|
Gets the Bluetooth Class Of Device information of the device.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothDevice.ConnectionStatus">
|
|
<summary>
|
|
Gets the connection status of the device.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothDevice.DeviceId">
|
|
<summary>
|
|
Gets the device Id.
|
|
</summary>
|
|
<value>The ID of the device.</value>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.BluetoothDevice.Name">
|
|
<summary>
|
|
Gets the Name of the device.
|
|
</summary>
|
|
<value>The name of the device.</value>
|
|
</member>
|
|
<member name="E:InTheHand.Devices.Bluetooth.BluetoothDevice.NameChanged">
|
|
<summary>
|
|
Occurs when the name of the device has changed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothDevice.ToString">
|
|
<summary>
|
|
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothError">
|
|
<summary>
|
|
Specifies common Bluetooth error cases.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.Success">
|
|
<summary>
|
|
The operation was successfully completed or serviced.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.RadioNotAvailable">
|
|
<summary>
|
|
The Bluetooth radio was not available.
|
|
This error occurs when the Bluetooth radio has been turned off.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.ResourceInUse">
|
|
<summary>
|
|
The operation cannot be serviced because the necessary resources are currently in use.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.DeviceNotConnected">
|
|
<summary>
|
|
The operation cannot be completed because the remote device is not connected.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.OtherError">
|
|
<summary>
|
|
An unexpected error has occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.DisabledByPolicy">
|
|
<summary>
|
|
The operation is disabled by policy.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.NotSupported">
|
|
<summary>
|
|
The operation is not supported on the current Bluetooth radio hardware.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.DisabledByUser">
|
|
<summary>
|
|
The operation is disabled by the user.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.ConsentRequired">
|
|
<summary>
|
|
The operation requires consent.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothError.TransportNotSupported">
|
|
<summary>
|
|
Not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothMajorClass">
|
|
<summary>
|
|
Indicates the Major Class code of the device, which is the general family of device with which the device is associated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Miscellaneous">
|
|
<summary>
|
|
Used when a more specific Major Class code is not suitable.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Computer">
|
|
<summary>
|
|
A computer.
|
|
Example devices are desktop, notebook, PDA and organizer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Phone">
|
|
<summary>
|
|
A phone.
|
|
Example devices are cellular, cordless, pay phone and modem.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.NetworkAccessPoint">
|
|
<summary>
|
|
A LAN or network Access Point.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.AudioVideo">
|
|
<summary>
|
|
An audio or video device.
|
|
Example devices are headset, speaker, stereo, video display and VCR.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Peripheral">
|
|
<summary>
|
|
A peripheral device.
|
|
Examples are mouse, joystick and keyboard.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Imaging">
|
|
<summary>
|
|
An imaging device.
|
|
Examples are printer, scanner, camera and display.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Wearable">
|
|
<summary>
|
|
A wearable device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Toy">
|
|
<summary>
|
|
A toy.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.Health">
|
|
<summary>
|
|
A health device.
|
|
An example is a heart rate monitor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothMinorClass">
|
|
<summary>
|
|
Indicates the Minor Class code of the device, which is the general family of device with which the device is associated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.Uncategorized">
|
|
<summary>
|
|
Use when a Minor Class code has not been assigned.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerDesktop">
|
|
<summary>
|
|
A desktop computer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerServer">
|
|
<summary>
|
|
A server computer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerLaptop">
|
|
<summary>
|
|
A laptop computer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerHandheld">
|
|
<summary>
|
|
A handheld PC/PDA.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerPalmSize">
|
|
<summary>
|
|
A palm-sized PC/PDA.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerWearable">
|
|
<summary>
|
|
A wearable, watch-sized, computer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ComputerTablet">
|
|
<summary>
|
|
A tablet computer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PhoneCellular">
|
|
<summary>
|
|
A cell phone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PhoneCordless">
|
|
<summary>
|
|
A cordless phone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PhoneSmartPhone">
|
|
<summary>
|
|
A smartphone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PhoneWired">
|
|
<summary>
|
|
A wired modem or voice gateway.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PhoneIsdn">
|
|
<summary>
|
|
Common ISDN access.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkFullyAvailable">
|
|
<summary>
|
|
Fully available.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsed01To17Percent">
|
|
<summary>
|
|
1% to 17% utilized.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsed17To33Percent">
|
|
<summary>
|
|
17% to 33% utilized.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsed33To50Percent">
|
|
<summary>
|
|
33% to 50% utilized.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsed50To67Percent">
|
|
<summary>
|
|
50% to 67% utilized.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsed67To83Percent">
|
|
<summary>
|
|
67% to 83% utilized.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsed83To99Percent">
|
|
<summary>
|
|
83% to 99% utilized.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.NetworkUsedNoServiceAvailable">
|
|
<summary>
|
|
Network service is not available.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoWearableHeadset">
|
|
<summary>
|
|
A wearable headset device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoHandsFree">
|
|
<summary>
|
|
A hands-free device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoMicrophone">
|
|
<summary>
|
|
A microphone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoLoudspeaker">
|
|
<summary>
|
|
A loudspeaker.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoHeadphones">
|
|
<summary>
|
|
Headphones.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoPortableAudio">
|
|
<summary>
|
|
Portable audio device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoCarAudio">
|
|
<summary>
|
|
A car audio device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoSetTopBox">
|
|
<summary>
|
|
A set-top box.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoHiFiAudioDevice">
|
|
<summary>
|
|
A HiFi audio device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoVcr">
|
|
<summary>
|
|
A VCR.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoVideoCamera">
|
|
<summary>
|
|
A video camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoCamcorder">
|
|
<summary>
|
|
A camcorder.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoVideoMonitor">
|
|
<summary>
|
|
A video monitor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoVideoDisplayAndLoudspeaker">
|
|
<summary>
|
|
A video display and loudspeaker.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoVideoConferencing">
|
|
<summary>
|
|
A video conferencing device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.AudioVideoGamingOrToy">
|
|
<summary>
|
|
A gaming console or toy.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralJoystick">
|
|
<summary>
|
|
A joystick.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralGamepad">
|
|
<summary>
|
|
A gamepad.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralRemoteControl">
|
|
<summary>
|
|
A remote control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralSensing">
|
|
<summary>
|
|
A sensing device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralDigitizerTablet">
|
|
<summary>
|
|
A digitizer tablet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralCardReader">
|
|
<summary>
|
|
A card reader.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralDigitalPen">
|
|
<summary>
|
|
A digital pen.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralHandheldScanner">
|
|
<summary>
|
|
A handheld scanner for bar codes, RFID, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.PeripheralHandheldGesture">
|
|
<summary>
|
|
A handheld gesture input device, such as a "wand" form factor device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ImagingDisplay">
|
|
<summary>
|
|
A display.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ImagingCamera">
|
|
<summary>
|
|
A camera.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ImagingScanner">
|
|
<summary>
|
|
A scanner.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ImagingPrinter">
|
|
<summary>
|
|
A printer;
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.WearableWristwatch">
|
|
<summary>
|
|
A wristwatch.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.WearablePager">
|
|
<summary>
|
|
A pager.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.WearableJacket">
|
|
<summary>
|
|
A jacket.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.WearableHelmet">
|
|
<summary>
|
|
A helmet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.WearableGlasses">
|
|
<summary>
|
|
Glasses.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ToyRobot">
|
|
<summary>
|
|
A robot.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ToyVehicle">
|
|
<summary>
|
|
A vehicle.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ToyDoll">
|
|
<summary>
|
|
A doll or action figure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ToyController">
|
|
<summary>
|
|
A controller.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.ToyGame">
|
|
<summary>
|
|
A game.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthBloodPressureMonitor">
|
|
<summary>
|
|
A blood pressure monitor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthThermometer">
|
|
<summary>
|
|
A thermometer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthWeighingScale">
|
|
<summary>
|
|
A weighing scale.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthGlucoseMeter">
|
|
<summary>
|
|
A glucose meter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthPulseOximeter">
|
|
<summary>
|
|
A pulse oximeter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthHeartRateMonitor">
|
|
<summary>
|
|
A heart rate or pulse monitor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthHealthDataDisplay">
|
|
<summary>
|
|
A health data display.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthStepCounter">
|
|
<summary>
|
|
A step counter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthBodyCompositionAnalyzer">
|
|
<summary>
|
|
A body composition analyzer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthPeakFlowMonitor">
|
|
<summary>
|
|
A peak flow monitor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthMedicationMonitor">
|
|
<summary>
|
|
A medication monitor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthKneeProsthesis">
|
|
<summary>
|
|
A knee prosthesis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthAnkleProsthesis">
|
|
<summary>
|
|
An ankle prosthesis.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthGenericHealthManager">
|
|
<summary>
|
|
A generic health manager.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothMinorClass.HealthPersonalMobilityDevice">
|
|
<summary>
|
|
A personal mobility device.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities">
|
|
<summary>
|
|
Indicates the service capabilities of a device.
|
|
</summary>
|
|
<remarks>
|
|
<para>Defined in Bluetooth Specifications <see href="https://www.bluetooth.com/specifications/assigned-numbers/baseband"/>.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.None">
|
|
<summary>
|
|
None.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.LimitedDiscoverableMode">
|
|
<summary>
|
|
Limited Discoverable Mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.PositioningService">
|
|
<summary>
|
|
Positioning or location identification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.NetworkingService">
|
|
<summary>
|
|
Networking, for example, LAN, Ad hoc.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.RenderingService">
|
|
<summary>
|
|
Rendering, for example, printer, speakers.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.CapturingService">
|
|
<summary>
|
|
Capturing, for example, scanner, microphone.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.ObjectTransferService">
|
|
<summary>
|
|
Object Transfer, for example, v-Inbox, v-folder.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.AudioService">
|
|
<summary>
|
|
Audio, for example, speaker, microphone, headset service.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.TelephoneService">
|
|
<summary>
|
|
Telephony, for example cordless, modem, headset service.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.InformationService">
|
|
<summary>
|
|
Information, for example, web server, WAP server.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.BluetoothUuidHelper">
|
|
<summary>
|
|
A helper class that provides methods to convert between bluetooth device UUID and short ID.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothUuidHelper.FromShortId(System.UInt32)">
|
|
<summary>
|
|
Returns the bluetooth device UUID from a short ID.
|
|
</summary>
|
|
<param name="shortId">The short ID.</param>
|
|
<returns>Returns the UUID.</returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.BluetoothUuidHelper.TryGetShortId(System.Guid)">
|
|
<summary>
|
|
Attempts to get the short bluetooth device ID from a UUID.
|
|
</summary>
|
|
<param name="uuid">The UUID.</param>
|
|
<returns>Returns the short ID.</returns>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceService">
|
|
<summary>
|
|
Represents an instance of a service on a remote Bluetooth device.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceService.GetDeviceSelector(InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId)">
|
|
<summary>
|
|
Gets an Advanced Query Syntax (AQS) string for identifying instances of an RFCOMM service.
|
|
</summary>
|
|
<param name="serviceId">The service id for which to query.</param>
|
|
<returns>An AQS string for identifying RFCOMM service instances.</returns>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceService.Device">
|
|
<summary>
|
|
Gets the <see cref="T:InTheHand.Devices.Bluetooth.BluetoothDevice"/> object describing the device associated with the current <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceService"/> object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ServiceId">
|
|
<summary>
|
|
Gets the RfcommServiceId of this RFCOMM service instance.
|
|
</summary>
|
|
<value>The RfcommServiceId of the RFCOMM service instance.</value>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceService.ToString">
|
|
<summary>
|
|
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult">
|
|
<summary>
|
|
The result of an Rfcomm device service request.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Error">
|
|
<summary>
|
|
Indicates that an error occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommDeviceServicesResult.Services">
|
|
<summary>
|
|
The collection of returned services.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId">
|
|
<summary>
|
|
Represents an RFCOMM service ID.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.SerialPort">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Serial Port (SPP) service (with short id 0x1101).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.DialupNetworking">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Dial-up Networking (DUN) service (with short id 0x1103).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.IrMCSync">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Synchronization service (with short id 0x1104).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexObjectPush">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized OBEX Object Push service (with short id 0x1105).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.ObexFileTransfer">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized OBEX File Transfer service (with short id 0x1106).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.Headset">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Headset Profile (HSP) (with short id 0x1108).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.AVRemoteControl">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Audio/Video Remote Control Profile (AVRCP) (with short id 0x110E).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.BasicImaging">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Basic Imaging service (with short id 0x111A).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.Handsfree">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Hands-free Profile (HFP) (with short id 0x111E).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.DirectPrinting">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Basic Printing service (with short id 0x1118).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.ReferencePrinting">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Basic Printing service (with short id 0x1119).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.PrintingStatus">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the printing status service for the Basic Printing Profile (BPP) (with short id 0x1123).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.HcrPrint">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Hardcopy Cable Replacement Profile (HCRP) for printing (with short id 0x1126).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.HcrScan">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Hardcopy Cable Replacement Profile (HCRP) for scanning (with short id 0x1127).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.SimAccess">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized SIM Access Profile (SAP) (with short id 0x112D).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPce">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Phone Book Access (PCE) service (with short id 0x112E).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.PhoneBookAccessPse">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Phone Book Access (PSE) service (with short id 0x112F).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.GenericFileTransfer">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Generic File Transfer service (with short id 0x1202).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.HealthDeviceSource">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Health Device Source service for Health Device Profile (HDP) (with short id 0x1401).
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.HealthDeviceSink">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object corresponding to the service id for the standardized Health Device Sink service for Health Device Profile (HDP) (with short id 0x1402).
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromShortId(System.UInt32)">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object from a 32-bit service id.
|
|
</summary>
|
|
<param name="shortId">The 32-bit service id.</param>
|
|
<returns>The <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object.</returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.FromUuid(System.Guid)">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object from a 128-bit service id.
|
|
</summary>
|
|
<param name="uuid">The 128-bit service id.</param>
|
|
<returns>The <see cref="T:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId"/> object.</returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.op_Implicit(InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId)~System.Guid">
|
|
<summary>
|
|
Implicit conversion from RfcommServiceId to Guid.
|
|
</summary>
|
|
<param name="id"></param>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.op_Implicit(System.Guid)~InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId">
|
|
<summary>
|
|
Implicit conversion from Guid to RfcommServiceId
|
|
</summary>
|
|
<param name="uuid"></param>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.Uuid">
|
|
<summary>
|
|
Retrieves the 128-bit service id.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsShortId">
|
|
<summary>
|
|
Converts the RfcommServiceId to a 32-bit service id if possible.
|
|
</summary>
|
|
<returns>Returns the 32-bit service id if the RfcommServiceId represents a standardized service.</returns>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Bluetooth.Rfcomm.RfcommServiceId.AsString">
|
|
<summary>
|
|
Converts the RfcommServiceId to a string.
|
|
</summary>
|
|
<returns>Returns the string representation of the 128-bit service id.</returns>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DeviceInformation">
|
|
<summary>
|
|
Represents a picker flyout that contains a list of devices for the user to choose from.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows Phone Silverlight</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DeviceInformation.Id">
|
|
<summary>
|
|
A string representing the identity of the device.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DeviceInformation.Name">
|
|
<summary>
|
|
The name of the device.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DeviceInformation.Pairing">
|
|
<summary>
|
|
Gets the information about the capabilities for this device to pair.
|
|
</summary>
|
|
<value>The pairing information for this device.</value>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Enumeration.DeviceInformation.ToString">
|
|
<summary>
|
|
Returns the Id of the <see cref="T:InTheHand.Devices.Enumeration.DeviceInformation"/>.
|
|
</summary>
|
|
<returns></returns>
|
|
<seealso cref="P:InTheHand.Devices.Enumeration.DeviceInformation.Id"/>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DeviceInformationPairing">
|
|
<summary>
|
|
Contains information and enables pairing for a device.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DeviceInformationPairing.CanPair">
|
|
<summary>
|
|
Gets a value that indicates whether the device can be paired.
|
|
</summary>
|
|
<value>True if the device can be paired, otherwise false.</value>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DeviceInformationPairing.IsPaired">
|
|
<summary>
|
|
Gets a value that indicates whether the device is currently paired.
|
|
</summary>
|
|
<value>True if the device is currently paired, otherwise false.</value>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DevicePairingKinds">
|
|
<summary>
|
|
Indicates the kinds of pairing supported by your application or requested by the system.
|
|
As an input value, use this value to indicate what kinds of pairing your application supports.
|
|
When this datatype is received as an output value, it indicates the kind of pairing requested by the system.
|
|
In this case, your code will need to respond accordingly.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingKinds.None">
|
|
<summary>
|
|
No pairing is supported.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingKinds.ConfirmOnly">
|
|
<summary>
|
|
The application must confirm they wish to perform the pairing action.
|
|
You can present an optional confirmation dialog to the user.
|
|
With a value of ConfirmOnly, Accept the pairing if you want it to complete.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingKinds.DisplayPin">
|
|
<summary>
|
|
The application must display the given PIN to the user.
|
|
The user will then need to enter or confirm that PIN on the device that is being paired.
|
|
With a value of DisplayPin, Accept the pairing if you want it to complete.
|
|
If your application cancels the pairing at this point, the device might still be paired.
|
|
This is because the system and the target device don't need any confirmation for this DevicePairingKinds value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingKinds.ProvidePin">
|
|
<summary>
|
|
The application must request a PIN from the user.
|
|
The PIN will typically be displayed on the target device.
|
|
With a value of ProvidePin, Accept the pairing and pass in the PIN as a parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingKinds.ConfirmPinMatch">
|
|
<summary>
|
|
The application must display the given PIN to the user and ask the user to confirm that the PIN matches the one show on the target device.
|
|
With a value of ConfirmPinMatch, Accept the pairing if you want it to complete.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DevicePairingResult">
|
|
<summary>
|
|
Contains information about the result of attempting to pair a device.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DevicePairingResult.Status">
|
|
<summary>
|
|
Gets the paired status of the device after the pairing action completed.
|
|
</summary>
|
|
<value>The paired status of the device.</value>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.Paired">
|
|
<summary>
|
|
The device object is now paired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.NotReadyToPair">
|
|
<summary>
|
|
The device object is not in a state where it can be paired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.NotPaired">
|
|
<summary>
|
|
The device object is not currently paired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.AlreadyPaired">
|
|
<summary>
|
|
The device object has already been paired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.ConnectionRejected">
|
|
<summary>
|
|
The device object rejected the connection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.TooManyConnections">
|
|
<summary>
|
|
The device object indicated it cannot accept any more incoming connections.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.HardwareFailure">
|
|
<summary>
|
|
The device object indicated there was a hardware failure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.AuthenticationTimeout">
|
|
<summary>
|
|
The authentication process timed out before it could complete.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.AuthenticationNotAllowed">
|
|
<summary>
|
|
The authentication protocol is not supported, so the device is not paired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.AuthenticationFailure">
|
|
<summary>
|
|
Authentication failed, so the device is not paired.
|
|
Either the device object or the application rejected the authentication.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.NoSupportedProfiles">
|
|
<summary>
|
|
There are no network profiles for this device object to use.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.ProtectionLevelCouldNotBeMet">
|
|
<summary>
|
|
The minimum level of protection is not supported by the device object or the application.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.AccessDenied">
|
|
<summary>
|
|
Your application does not have the appropriate permissions level to pair the device object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.InvalidCeremonyData">
|
|
<summary>
|
|
The ceremony data was incorrect.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.PairingCanceled">
|
|
<summary>
|
|
The pairing action was canceled before completion.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.OperationAlreadyInProgress">
|
|
<summary>
|
|
The device object is already attempting to pair or unpair.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.RequiredHandlerNotRegistered">
|
|
<summary>
|
|
Either the event handler wasn't registered or a required DevicePairingKinds was not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.RejectedByHandler">
|
|
<summary>
|
|
The application handler rejected the pairing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.RemoteDeviceHasAssociation">
|
|
<summary>
|
|
The remove device already has an association.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DevicePairingResultStatus.Failed">
|
|
<summary>
|
|
An unknown failure occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DevicePicker">
|
|
<summary>
|
|
Represents a picker flyout that contains a list of devices for the user to choose from.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
|
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:InTheHand.Devices.Enumeration.DevicePicker.#ctor">
|
|
<summary>
|
|
Creates a <see cref="T:InTheHand.Devices.Enumeration.DevicePicker"/> object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DevicePicker.Filter">
|
|
<summary>
|
|
Gets the filter used to choose what devices to show in the picker.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
|
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Windows 7 or later</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DevicePickerFilter">
|
|
<summary>
|
|
Represents the filter used to determine which devices to show in the device picker.
|
|
The filter parameters are OR-ed together to build the resulting filter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DevicePickerFilter.SupportedDeviceSelectors">
|
|
<summary>
|
|
Gets a list of AQS filter strings.
|
|
This defaults to empty list (no filter).
|
|
You can add one or more AQS filter strings to this vector and filter the devices list to those that meet one or more of the provided filters.
|
|
</summary>
|
|
<remarks>
|
|
Some platforms have limitations on the filter types they support:-
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Supports only a small set of ClassOfDevice restrictions.
|
|
<see cref="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.AudioService"/>,
|
|
<see cref="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.ObjectTransferService"/>,
|
|
<see cref="F:InTheHand.Devices.Bluetooth.BluetoothServiceCapabilities.NetworkingService"/>,
|
|
<see cref="F:InTheHand.Devices.Bluetooth.BluetoothMajorClass.NetworkAccessPoint"/> any other class values will display all device types.</description></item>
|
|
<item><term>Windows UWP</term><description>No restrictions. Additional filter types are added in Creators Update.</description></item>
|
|
<item><term>Windows Store</term><description>No restrictions</description></item>
|
|
<item><term>Windows Phone Store</term><description>No restrictions</description></item>
|
|
<item><term>Windows (Desktop Apps)</term><description>Supports <see cref="!:BluetoothDevice.GetDeviceSelectorFromClassOfDevice()"/> and <see cref="!:BluetoothDevice.GetDeviceSelectorFromPairingState()"/>.</description></item></list>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DeviceUnpairingResult">
|
|
<summary>
|
|
Contains information about the result of attempting to unpair a device.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Devices.Enumeration.DeviceUnpairingResult.Status">
|
|
<summary>
|
|
Gets the paired status of the device after the unpairing action completed.
|
|
</summary>
|
|
<value>The paired status of the device.</value>
|
|
</member>
|
|
<member name="T:InTheHand.Devices.Enumeration.DeviceUnpairingResultStatus">
|
|
<summary>
|
|
The result of the unpairing action.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DeviceUnpairingResultStatus.Unpaired">
|
|
<summary>
|
|
The device object is successfully unpaired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DeviceUnpairingResultStatus.AlreadyUnpaired">
|
|
<summary>
|
|
The device object was already unpaired.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DeviceUnpairingResultStatus.OperationAlreadyInProgress">
|
|
<summary>
|
|
The device object is currently in the middle of either a pairing or unpairing action.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DeviceUnpairingResultStatus.AccessDenied">
|
|
<summary>
|
|
The caller does not have sufficient permissions to unpair the device.
|
|
</summary>
|
|
</member>
|
|
<member name="F:InTheHand.Devices.Enumeration.DeviceUnpairingResultStatus.Failed">
|
|
<summary>
|
|
An unknown failure occurred.
|
|
</summary>
|
|
</member>
|
|
<member name="T:InTheHand.Networking.Sockets.NetworkStream">
|
|
<summary>
|
|
Provides the underlying stream of data for network access.
|
|
</summary>
|
|
<remarks>
|
|
<para/><list type="table">
|
|
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
|
<item><term>Android</term><description>Android 4.4 and later</description></item>
|
|
<item><term>Windows UWP</term><description>Windows 10</description></item>
|
|
<item><term>Windows Store</term><description>Windows 8.1 or later</description></item>
|
|
<item><term>Windows Phone Store</term><description>Windows Phone 8.1 or later</description></item></list>
|
|
</remarks>
|
|
<seealso cref="T:System.Net.Sockets.NetworkStream"/>
|
|
</member>
|
|
<member name="P:InTheHand.Networking.Sockets.NetworkStream.CanRead">
|
|
<summary>
|
|
Gets a value that indicates whether the NetworkStream supports reading.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Networking.Sockets.NetworkStream.CanSeek">
|
|
<summary>
|
|
Gets a value that indicates whether the stream supports seeking. This property is not currently supported.
|
|
</summary>
|
|
<value>This property always returns false.</value>
|
|
</member>
|
|
<member name="P:InTheHand.Networking.Sockets.NetworkStream.CanWrite">
|
|
<summary>
|
|
Gets a value that indicates whether the NetworkStream supports writing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Networking.Sockets.NetworkStream.Length">
|
|
<summary>
|
|
Gets the length of the data available on the stream.
|
|
This property is not currently supported and always throws a NotSupportedException.
|
|
</summary>
|
|
</member>
|
|
<member name="P:InTheHand.Networking.Sockets.NetworkStream.Position">
|
|
<summary>
|
|
Gets or sets the current position in the stream.
|
|
This property is not currently supported and always throws a NotSupportedException.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Flush">
|
|
<summary>
|
|
Flushes data from the stream.
|
|
</summary>
|
|
</member>
|
|
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Reads data from the NetworkStream.
|
|
</summary>
|
|
<param name="buffer"></param>
|
|
<param name="offset"></param>
|
|
<param name="count"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
|
<summary>
|
|
Sets the current position of the stream to the given value.
|
|
This method is not currently supported and always throws a NotSupportedException.
|
|
</summary>
|
|
<param name="offset"></param>
|
|
<param name="origin"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:InTheHand.Networking.Sockets.NetworkStream.SetLength(System.Int64)">
|
|
<summary>
|
|
Sets the length of the stream.
|
|
This method always throws a NotSupportedException.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Writes data to the NetworkStream.
|
|
</summary>
|
|
<param name="buffer"></param>
|
|
<param name="offset"></param>
|
|
<param name="count"></param>
|
|
</member>
|
|
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases the unmanaged resources used by the NetworkStream and optionally releases the managed resources.
|
|
</summary>
|
|
<param name="disposing"></param>
|
|
</member>
|
|
<member name="M:InTheHand.Net.Sockets.MonoBluetoothSocket.#ctor">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|