GattLocalCharacteristic
GattLocalCharacteristic
GattLocalCharacteristic
GattLocalCharacteristic
Class
Definition
This class represents a local characteristic.
public : sealed class GattLocalCharacteristic : IGattLocalCharacteristicpublic sealed class GattLocalCharacteristic : IGattLocalCharacteristicPublic NotInheritable Class GattLocalCharacteristic Implements IGattLocalCharacteristic// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Properties
CharacteristicProperties CharacteristicProperties CharacteristicProperties CharacteristicProperties
Gets the local characteristic properties.
public : GattCharacteristicProperties CharacteristicProperties { get; }public GattCharacteristicProperties CharacteristicProperties { get; }Public ReadOnly Property CharacteristicProperties As GattCharacteristicProperties// You can use this property in JavaScript.
- Value
- GattCharacteristicProperties GattCharacteristicProperties GattCharacteristicProperties GattCharacteristicProperties
The local characteristic properties.
Descriptors Descriptors Descriptors Descriptors
Gets a vector list of all the descriptors for this local characteristic.
public : IVectorView<GattLocalDescriptor> Descriptors { get; }public IReadOnlyList<GattLocalDescriptor> Descriptors { get; }Public ReadOnly Property Descriptors As IReadOnlyList<GattLocalDescriptor>// You can use this property in JavaScript.
- Value
- IVectorView<GattLocalDescriptor> IReadOnlyList<GattLocalDescriptor> IReadOnlyList<GattLocalDescriptor> IReadOnlyList<GattLocalDescriptor>
A vector list of all the descriptors for this local characteristic.
PresentationFormats PresentationFormats PresentationFormats PresentationFormats
Gets the presentation formats for this local characteristic.
public : IVectorView<GattPresentationFormat> PresentationFormats { get; }public IReadOnlyList<GattPresentationFormat> PresentationFormats { get; }Public ReadOnly Property PresentationFormats As IReadOnlyList<GattPresentationFormat>// You can use this property in JavaScript.
- Value
- IVectorView<GattPresentationFormat> IReadOnlyList<GattPresentationFormat> IReadOnlyList<GattPresentationFormat> IReadOnlyList<GattPresentationFormat>
The presentation formats for this local characteristic.
ReadProtectionLevel ReadProtectionLevel ReadProtectionLevel ReadProtectionLevel
Gets the read protection level of this local characteristic.
public : GattProtectionLevel ReadProtectionLevel { get; }public GattProtectionLevel ReadProtectionLevel { get; }Public ReadOnly Property ReadProtectionLevel As GattProtectionLevel// You can use this property in JavaScript.
The read protection level of this local characteristic.
StaticValue StaticValue StaticValue StaticValue
Gets the static value for this local GATT characteristic.
public : IBuffer StaticValue { get; }public IBuffer StaticValue { get; }Public ReadOnly Property StaticValue As IBuffer// You can use this property in JavaScript.
SubscribedClients SubscribedClients SubscribedClients SubscribedClients
Gets a vector list of all clients that are subscribed to this local characteristic.
public : IVectorView<GattSubscribedClient> SubscribedClients { get; }public IReadOnlyList<GattSubscribedClient> SubscribedClients { get; }Public ReadOnly Property SubscribedClients As IReadOnlyList<GattSubscribedClient>// You can use this property in JavaScript.
- Value
- IVectorView<GattSubscribedClient> IReadOnlyList<GattSubscribedClient> IReadOnlyList<GattSubscribedClient> IReadOnlyList<GattSubscribedClient>
A vector list of all clients that are subscribed to this local characteristic.
UserDescription UserDescription UserDescription UserDescription
Gets the user-friendly description for this local characteristic.
public : PlatForm::String UserDescription { get; }public string UserDescription { get; }Public ReadOnly Property UserDescription As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The user-friendly description for this local characteristic.
Uuid Uuid Uuid Uuid
Gets the BluetoothSIG-defined UUID for this local characteristic.
public : PlatForm::Guid Uuid { get; }public Guid Uuid { get; }Public ReadOnly Property Uuid As Guid// You can use this property in JavaScript.
- Value
- PlatForm::Guid Guid Guid Guid
The BluetoothSIG-defined UUID for this local characteristic.
WriteProtectionLevel WriteProtectionLevel WriteProtectionLevel WriteProtectionLevel
Gets the write protection level of this local characteristic.
public : GattProtectionLevel WriteProtectionLevel { get; }public GattProtectionLevel WriteProtectionLevel { get; }Public ReadOnly Property WriteProtectionLevel As GattProtectionLevel// You can use this property in JavaScript.
The write protection level of this local characteristic.
Methods
CreateDescriptorAsync(Guid, GattLocalDescriptorParameters) CreateDescriptorAsync(Guid, GattLocalDescriptorParameters) CreateDescriptorAsync(Guid, GattLocalDescriptorParameters) CreateDescriptorAsync(Guid, GattLocalDescriptorParameters)
Creates descriptor for this local characteristic.
public : IAsyncOperation<GattLocalDescriptorResult> CreateDescriptorAsync(PlatForm::Guid descriptorUuid, GattLocalDescriptorParameters parameters)public IAsyncOperation<GattLocalDescriptorResult> CreateDescriptorAsync(Guid descriptorUuid, GattLocalDescriptorParameters parameters)Public Function CreateDescriptorAsync(descriptorUuid As Guid, parameters As GattLocalDescriptorParameters) As IAsyncOperation( Of GattLocalDescriptorResult )// You can use this method in JavaScript.
- descriptorUuid
- PlatForm::Guid Guid Guid Guid
The descriptor UUID.
- parameters
- GattLocalDescriptorParameters GattLocalDescriptorParameters GattLocalDescriptorParameters GattLocalDescriptorParameters
The parameters for the descriptor.
An asynchronous operation that completes with a GattLocalDescriptorResult object.
NotifyValueAsync(IBuffer) NotifyValueAsync(IBuffer) NotifyValueAsync(IBuffer) NotifyValueAsync(IBuffer)
Send and notifies all subscribed clients a GattSubscribedClient of a value.
public : IAsyncOperation<IVectorView<GattClientNotificationResult>> NotifyValueAsync(IBuffer value)public IAsyncOperation<IReadOnlyList<GattClientNotificationResult>> NotifyValueAsync(IBuffer value)Public Function NotifyValueAsync(value As IBuffer) As IAsyncOperation( Of IReadOnlyListGattClientNotificationResult )// You can use this method in JavaScript.
The buffer that contains the value to send to the GattSubscribedClient.
An asynchronous operation that completes with a vector list of all the GattClientNotificationResult for each subscribed client.
NotifyValueAsync(IBuffer, GattSubscribedClient) NotifyValueAsync(IBuffer, GattSubscribedClient) NotifyValueAsync(IBuffer, GattSubscribedClient) NotifyValueAsync(IBuffer, GattSubscribedClient)
Sends and notifies a GattSubscribedClient of a value.
public : IAsyncOperation<GattClientNotificationResult> NotifyValueAsync(IBuffer value, GattSubscribedClient subscribedClient)public IAsyncOperation<GattClientNotificationResult> NotifyValueAsync(IBuffer value, GattSubscribedClient subscribedClient)Public Function NotifyValueAsync(value As IBuffer, subscribedClient As GattSubscribedClient) As IAsyncOperation( Of GattClientNotificationResult )// You can use this method in JavaScript.
The buffer that contains the value to send to the GattSubscribedClient.
- subscribedClient
- GattSubscribedClient GattSubscribedClient GattSubscribedClient GattSubscribedClient
The subscribed client notify the value.
An asynchronous operation that completes with a GattClientNotificationResult object.
Events
ReadRequested ReadRequested ReadRequested ReadRequested
An event that is triggered when a GATT client requests a read operation.
public : event TypedEventHandler ReadRequested<GattLocalCharacteristic, GattReadRequestedEventArgs>public event TypedEventHandler ReadRequested<GattLocalCharacteristic, GattReadRequestedEventArgs>Public Event ReadRequested<GattLocalCharacteristic, GattReadRequestedEventArgs>// You can use this event in JavaScript.
SubscribedClientsChanged SubscribedClientsChanged SubscribedClientsChanged SubscribedClientsChanged
An event that triggers when the clients subscribed to this local characteristic changes.
public : event TypedEventHandler SubscribedClientsChanged<GattLocalCharacteristic, object>public event TypedEventHandler SubscribedClientsChanged<GattLocalCharacteristic, object>Public Event SubscribedClientsChanged<GattLocalCharacteristic, object>// You can use this event in JavaScript.
WriteRequested WriteRequested WriteRequested WriteRequested
This is an event that is triggered when a write was requested.
public : event TypedEventHandler WriteRequested<GattLocalCharacteristic, GattWriteRequestedEventArgs>public event TypedEventHandler WriteRequested<GattLocalCharacteristic, GattWriteRequestedEventArgs>Public Event WriteRequested<GattLocalCharacteristic, GattWriteRequestedEventArgs>// You can use this event in JavaScript.