@sfourdrinier/react-native-ble-plx/lib/typescript/src/Characteristic.d.ts

React Native Bluetooth Low Energy library

import type { BleManager } from './BleManager';
import type { BleError } from './BleError';
import { Descriptor } from './Descriptor';
import type { NativeCharacteristic } from './BleModule';
import type { DeviceId, Identifier, UUID, TransactionId, CharacteristicSubscriptionType, Base64, Subscription } from './TypeDefinition';
/**
 * Characteristic object.
 */
export declare class Characteristic implements NativeCharacteristic {
    /**
     * Internal BLE Manager handle
     * @private
     */
    _manager: BleManager;
    /**
     * Characteristic unique identifier
     */
    id: Identifier;
    /**
     * Characteristic UUID
     */
    uuid: UUID;
    /**
     * Service's ID to which characteristic belongs
     */
    serviceID: Identifier;
    /**
     * Service's UUID to which characteristic belongs
     */
    serviceUUID: UUID;
    /**
     * Device's ID to which characteristic belongs
     */
    deviceID: DeviceId;
    /**
     * True if characteristic can be read
     */
    isReadable: boolean;
    /**
     * True if characteristic can be written with response
     */
    isWritableWithResponse: boolean;
    /**
     * True if characteristic can be written without response
     */
    isWritableWithoutResponse: boolean;
    /**
     * True if characteristic can monitor value changes.
     */
    isNotifiable: boolean;
    /**
     * True if characteristic is monitoring value changes without ACK.
     */
    isNotifying: boolean;
    /**
     * True if characteristic is monitoring value changes with ACK.
     */
    isIndicatable: boolean;
    /**
     * Characteristic value if present
     */
    value: Base64 | null;
    /**
     * Private constructor used to create instance of {@link Characteristic}.
     * @param {NativeCharacteristic} nativeCharacteristic NativeCharacteristic
     * @param {BleManager} manager BleManager
     * @private
     */
    constructor(nativeCharacteristic: NativeCharacteristic, manager: BleManager);
    /**
     * {@link #blemanagerdescriptorsfordevice|bleManager.descriptorsForDevice()} with partially filled arguments.
     *
     * @returns {Promise<Array<Descriptor>>} Promise which emits array of {@link Descriptor} objects which are
     * discovered for this {@link Characteristic}.
     */
    descriptors(): Promise<Array<Descriptor>>;
    /**
     * {@link #blemanagerreadcharacteristicfordevice|bleManager.readCharacteristicForDevice()} with partially filled arguments.
     *
     * @param {?TransactionId} transactionId optional `transactionId` which can be used in
     * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
     * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value will be stored
     * inside returned object.
     */
    read(transactionId?: TransactionId): Promise<Characteristic>;
    /**
     * {@link #blemanagerwritecharacteristicwithresponsefordevice|bleManager.writeCharacteristicWithResponseForDevice()} with partially filled arguments.
     *
     * @param {Base64} valueBase64 Value in Base64 format.
     * @param {?TransactionId} transactionId optional `transactionId` which can be used in
     * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
     * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value may
     * not be stored inside returned object.
     */
    writeWithResponse(valueBase64: Base64, transactionId?: TransactionId): Promise<Characteristic>;
    /**
     * {@link #blemanagerwritecharacteristicwithoutresponsefordevice|bleManager.writeCharacteristicWithoutResponseForDevice()} with partially filled arguments.
     *
     * @param {Base64} valueBase64 Value in Base64 format.
     * @param {?TransactionId} transactionId optional `transactionId` which can be used in
     * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
     * @returns {Promise<Characteristic>} Promise which emits this {@link Characteristic}. Latest value may
     * not be stored inside returned object.
     */
    writeWithoutResponse(valueBase64: Base64, transactionId?: TransactionId): Promise<Characteristic>;
    /**
     * {@link #blemanagermonitorcharacteristicfordevice|bleManager.monitorCharacteristicForDevice()} with partially filled arguments.
     *
     * @param {function(error: ?BleError, characteristic: ?Characteristic)} listener callback which emits
     * this {@link Characteristic} with modified value for each notification.
     * @param {?TransactionId} transactionId optional `transactionId` which can be used in
     * @param {?CharacteristicSubscriptionType} subscriptionType [android only] subscription type of the characteristic
     * {@link #blemanagercanceltransaction|bleManager.cancelTransaction()} function.
     * @returns {Subscription} Subscription on which `remove()` function can be called to unsubscribe.
     */
    monitor(listener: (error: BleError | null, characteristic: Characteristic | null) => void, transactionId?: TransactionId | null, subscriptionType?: CharacteristicSubscriptionType | null): Subscription;
    /**
     * {@link #blemanagerreaddescriptorfordevice|bleManager.readDescriptorForDevice()} with partially filled arguments.
     *
     * @param {UUID} descriptorUUID {@link Descriptor} UUID.
     * @param {?TransactionId} transactionId optional `transactionId` which can be used in
     * {@link #blemanagercanceltransaction|cancelTransaction()} function.
     * @returns {Promise<Descriptor>} Promise which emits first {@link Descriptor} object matching specified
     * UUID paths. Latest value of {@link Descriptor} will be stored inside returned object.
     */
    readDescriptor(descriptorUUID: UUID, transactionId?: TransactionId): Promise<Descriptor>;
    /**
     * {@link #blemanagerwritedescriptorfordevice|bleManager.writeDescriptorForDevice()} with partially filled arguments.
     *
     * @param {UUID} descriptorUUID Descriptor UUID
     * @param {Base64} valueBase64 Value to be set coded in Base64
     * @param {?TransactionId} transactionId Transaction handle used to cancel operation
     * @returns {Promise<Descriptor>} Descriptor which saved passed value.
     */
    writeDescriptor(descriptorUUID: UUID, valueBase64: Base64, transactionId?: TransactionId): Promise<Descriptor>;
}
//# sourceMappingURL=Characteristic.d.ts.map