GattCharacteristic GattCharacteristic GattCharacteristic GattCharacteristic Class

Gets the handle used to uniquely identify GATT-based characteristic attributes as declared on the Bluetooth LE device.

public : ushort AttributeHandle { get; }public ushort AttributeHandle { get; }Public ReadOnly Property AttributeHandle As ushort// You can use this property in JavaScript.

Gets the GATT characteristic properties, as defined by the GATT profile.

If the ExtendedProperties flag is present it also represents the properties of the Extended Characteristic Properties Descriptor.

public : GattCharacteristicProperties CharacteristicProperties { get; }public GattCharacteristicProperties CharacteristicProperties { get; }Public ReadOnly Property CharacteristicProperties As GattCharacteristicProperties// You can use this property in JavaScript.

Gets the list of presentation format descriptors associated with this GattCharacteristic, in the order specified by the Aggregate Format Descriptor.

The list shall be empty if no PresentationFormat or Aggregate Format descriptors are found.

public : IVectorView<GattPresentationFormat> PresentationFormats { get; }public IReadOnlyList<GattPresentationFormat> PresentationFormats { get; }Public ReadOnly Property PresentationFormats As IReadOnlyList<GattPresentationFormat>// You can use this property in JavaScript.

Gets or sets the desired GATT security options for over the air communication with the device.

Windows will negotiate the maximum security possible with the device as part of the pairing process, and specifying a lower level of security won’t degrade the existing security level.

public : GattProtectionLevel ProtectionLevel { get; set; }public GattProtectionLevel ProtectionLevel { get; set; }Public ReadWrite Property ProtectionLevel As GattProtectionLevel// You can use this property in JavaScript.

Gets the GattDeviceService of which this characteristic is a member.

public : GattDeviceService Service { get; }public GattDeviceService Service { get; }Public ReadOnly Property Service As GattDeviceService// You can use this property in JavaScript.

Get the user friendly description for this GattCharacteristic, if the User Description Descriptor is present, otherwise this will be an empty string.

public : PlatForm::String UserDescription { get; }public string UserDescription { get; }Public ReadOnly Property UserDescription As string// You can use this property in JavaScript.

Gets the GATT Characteristic UUID for this GattCharacteristic.

public : PlatForm::Guid Uuid { get; }public Guid Uuid { get; }Public ReadOnly Property Uuid As Guid// You can use this property in JavaScript.

Converts a Bluetooth SIG defined short Id to a full GATT UUID.

public : static PlatForm::Guid ConvertShortIdToUuid(unsigned short shortId)public static Guid ConvertShortIdToUuid(UInt16 shortId)Public Static Function ConvertShortIdToUuid(shortId As UInt16) As Guid// You can use this method in JavaScript.

Gets the collection of all descriptors belonging to this GattCharacteristic instance.

public : IVectorView<GattDescriptor> GetAllDescriptors()public IReadOnlyList<GattDescriptor> GetAllDescriptors()Public Function GetAllDescriptors() As IReadOnlyList( Of GattDescriptor )// You can use this method in JavaScript.

Returns a vector of descriptors, that are identified by the specified UUID, and belong to this GattCharacteristic instance.

public : IVectorView<GattDescriptor> GetDescriptors(PlatForm::Guid descriptorUuid)public IReadOnlyList<GattDescriptor> GetDescriptors(Guid descriptorUuid)Public Function GetDescriptors(descriptorUuid As Guid) As IReadOnlyList( Of GattDescriptor )// You can use this method in JavaScript.

Returns the descriptors for this GattCharacteristic instance.

public : IAsyncOperation<GattDescriptorsResult> GetDescriptorsAsync()public IAsyncOperation<GattDescriptorsResult> GetDescriptorsAsync()Public Function GetDescriptorsAsync() As IAsyncOperation( Of GattDescriptorsResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Returns the descriptors with the specified cache mode for this GattCharacteristic instance.

public : IAsyncOperation<GattDescriptorsResult> GetDescriptorsAsync(BluetoothCacheMode cacheMode)public IAsyncOperation<GattDescriptorsResult> GetDescriptorsAsync(BluetoothCacheMode cacheMode)Public Function GetDescriptorsAsync(cacheMode As BluetoothCacheMode) As IAsyncOperation( Of GattDescriptorsResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Returns the descriptors whose UUIDs match descriptorUuid.

public : IAsyncOperation<GattDescriptorsResult> GetDescriptorsForUuidAsync(PlatForm::Guid descriptorUuid)public IAsyncOperation<GattDescriptorsResult> GetDescriptorsForUuidAsync(Guid descriptorUuid)Public Function GetDescriptorsForUuidAsync(descriptorUuid As Guid) As IAsyncOperation( Of GattDescriptorsResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Returns the descriptors whose UUIDs match descriptorUuid with the specified cacheMode.

public : IAsyncOperation<GattDescriptorsResult> GetDescriptorsForUuidAsync(PlatForm::Guid descriptorUuid, BluetoothCacheMode cacheMode)public IAsyncOperation<GattDescriptorsResult> GetDescriptorsForUuidAsync(Guid descriptorUuid, BluetoothCacheMode cacheMode)Public Function GetDescriptorsForUuidAsync(descriptorUuid As Guid, cacheMode As BluetoothCacheMode) As IAsyncOperation( Of GattDescriptorsResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Reads the current value of the ClientCharacteristicConfigurationDescriptor.

public : IAsyncOperation<GattReadClientCharacteristicConfigurationDescriptorResult> ReadClientCharacteristicConfigurationDescriptorAsync()public IAsyncOperation<GattReadClientCharacteristicConfigurationDescriptorResult> ReadClientCharacteristicConfigurationDescriptorAsync()Public Function ReadClientCharacteristicConfigurationDescriptorAsync() As IAsyncOperation( Of GattReadClientCharacteristicConfigurationDescriptorResult )// You can use this method in JavaScript.

Performs a Characteristic Value read from the value cache maintained by Windows.

public : IAsyncOperation<GattReadResult> ReadValueAsync()public IAsyncOperation<GattReadResult> ReadValueAsync()Public Function ReadValueAsync() As IAsyncOperation( Of GattReadResult )// You can use this method in JavaScript.

See Also

ReadValueAsync(BluetoothCacheMode)ReadValueAsync(BluetoothCacheMode)ReadValueAsync(BluetoothCacheMode)ReadValueAsync(BluetoothCacheMode)

Performs a Characteristic Value read either from the value cache maintained by Windows, or directly from the device.

public : IAsyncOperation<GattReadResult> ReadValueAsync(BluetoothCacheMode cacheMode)public IAsyncOperation<GattReadResult> ReadValueAsync(BluetoothCacheMode cacheMode)Public Function ReadValueAsync(cacheMode As BluetoothCacheMode) As IAsyncOperation( Of GattReadResult )// You can use this method in JavaScript.

See Also

ReadValueAsync()ReadValueAsync()ReadValueAsync()ReadValueAsync()

Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device.

public : IAsyncOperation<GattCommunicationStatus> WriteClientCharacteristicConfigurationDescriptorAsync(GattClientCharacteristicConfigurationDescriptorValue clientCharacteristicConfigurationDescriptorValue)public IAsyncOperation<GattCommunicationStatus> WriteClientCharacteristicConfigurationDescriptorAsync(GattClientCharacteristicConfigurationDescriptorValue clientCharacteristicConfigurationDescriptorValue)Public Function WriteClientCharacteristicConfigurationDescriptorAsync(clientCharacteristicConfigurationDescriptorValue As GattClientCharacteristicConfigurationDescriptorValue) As IAsyncOperation( Of GattCommunicationStatus )// You can use this method in JavaScript.

Writes the ClientCharacteristicConfigurationDescriptor to the Bluetooth LE device, and if the value to be written represents an indication or a notification and a ValueChanged event handler is registered, enables receiving ValueChanged events from the device.

public : IAsyncOperation<GattWriteResult> WriteClientCharacteristicConfigurationDescriptorWithResultAsync(GattClientCharacteristicConfigurationDescriptorValue clientCharacteristicConfigurationDescriptorValue)public IAsyncOperation<GattWriteResult> WriteClientCharacteristicConfigurationDescriptorWithResultAsync(GattClientCharacteristicConfigurationDescriptorValue clientCharacteristicConfigurationDescriptorValue)Public Function WriteClientCharacteristicConfigurationDescriptorWithResultAsync(clientCharacteristicConfigurationDescriptorValue As GattClientCharacteristicConfigurationDescriptorValue) As IAsyncOperation( Of GattWriteResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Performs a Characteristic Value write to a Bluetooth LE device.

public : IAsyncOperation<GattCommunicationStatus> WriteValueAsync(IBuffer value)public IAsyncOperation<GattCommunicationStatus> WriteValueAsync(IBuffer value)Public Function WriteValueAsync(value As IBuffer) As IAsyncOperation( Of GattCommunicationStatus )// You can use this method in JavaScript.

See Also

WriteValueAsync(IBuffer, GattWriteOption)WriteValueAsync(IBuffer, GattWriteOption)WriteValueAsync(IBuffer, GattWriteOption)WriteValueAsync(IBuffer, GattWriteOption)

Performs a Characteristic Value write to a Bluetooth LE device.

public : IAsyncOperation<GattCommunicationStatus> WriteValueAsync(IBuffer value, GattWriteOption writeOption)public IAsyncOperation<GattCommunicationStatus> WriteValueAsync(IBuffer value, GattWriteOption writeOption)Public Function WriteValueAsync(value As IBuffer, writeOption As GattWriteOption) As IAsyncOperation( Of GattCommunicationStatus )// You can use this method in JavaScript.

See Also

WriteValueAsync(IBuffer)WriteValueAsync(IBuffer)WriteValueAsync(IBuffer)WriteValueAsync(IBuffer)

Performs a Characteristic Value write to a Bluetooth LE device.

public : IAsyncOperation<GattWriteResult> WriteValueWithResultAsync(IBuffer value)public IAsyncOperation<GattWriteResult> WriteValueWithResultAsync(IBuffer value)Public Function WriteValueWithResultAsync(value As IBuffer) As IAsyncOperation( Of GattWriteResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

Performs a Characteristic Value write to a Bluetooth LE device.

public : IAsyncOperation<GattWriteResult> WriteValueWithResultAsync(IBuffer value, GattWriteOption writeOption)public IAsyncOperation<GattWriteResult> WriteValueWithResultAsync(IBuffer value, GattWriteOption writeOption)Public Function WriteValueWithResultAsync(value As IBuffer, writeOption As GattWriteOption) As IAsyncOperation( Of GattWriteResult )// You can use this method in JavaScript.

Device family	Windows 10 Creators Update (introduced v10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v4)

An App can register an event handler in order to receive events when notification or indications are received from a device, after setting the Client Characteristic Configuration Descriptor.

public : event TypedEventHandler ValueChanged<GattCharacteristic,  GattValueChangedEventArgs>public event TypedEventHandler ValueChanged<GattCharacteristic,  GattValueChangedEventArgs>Public Event ValueChanged<GattCharacteristic,  GattValueChangedEventArgs>// You can use this event in JavaScript.

Remarks

The GattValueChangedEventArgs object represents the arguments received by a ValueChanged event handler used to process characteristic value change notification and indication events sent by a Bluetooth LE device.