VLDBluetoothPeripheral

Objective-C

@interface VLDBluetoothPeripheral

Swift

class VLDBluetoothPeripheral

The VLDBluetoothPeripheral class represents Bluetooth peripheral models that can be discovered or read from by VLDBluetoothPeripheralController.

  • Indicates if a peripheral model requires a Bluetooth pairing before it can be used. If a peripheral requires pairing, you must first call pairPeripheral: on VLDBluetoothPeripheralController at least once before calling readFromPeripheral: on VLDBluetoothPeripheralController.

    Declaration

    Objective-C

    @property (nonatomic) BOOL requiresPairing;

    Swift

    var requiresPairing: Int32 { get set }
  • Text to be presented to the user when readFromPeripheral: is called on VLDBluetoothPeripheralController.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *instructions;
  • Text to be presented to the user when the isReadyToReadFromPeripheral: callback is sent to the VLDBluetoothPeripheralControllerDelegate.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *readingInstructions;
  • Text to be presented to the user when pairPeripheral: is called on VLDBluetoothPeripheralController and VLDBluetoothPeripheral property requiresPairing is TRUE

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *pairingInstructions;
  • A version string (e.g. 1.4.2) indicating which version of the library supports this peripheral model

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *version;
  • Returns the peripheral for the given ID

    Declaration

    Objective-C

    + (VLDBluetoothPeripheral *_Nullable)peripheralForID:(NSUInteger)peripheralID;

    Swift

    /*not inherited*/ init?(forID peripheralID: Any!)

    Parameters

    peripheralID

    the ID of the peripheral to retrieve.

  • Accessor for regular expression based on broadcasting name

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSRegularExpression *_Nonnull broadcastingNameRegex;