VLDPeripheral

@interface VLDPeripheral : VLDModel

The VLDPeripheral class is an abstract class. You should never instantiate a VLDPeripheral object directly. Instead, you always work with one of its concrete subclasses: VLDBluetoothPeripheral or VLDOCRPeripheral.

  • A unique identifer for a particular peripheral model.

    Instead of storing an actual VLDPeripheral object for persistence, it is preferred to store the peripheralID and then later retrieve the object using peripheralForID: with VLDBluetoothPeripheral or VLDOCRPeripheral.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int peripheralID;

  • The type of the peripheral, used to identify its function.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int type;

  • Model number of the peripheral.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *model

  • Manufacturer name of the peripheral.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *manufacturer

  • URL for an image of the peripheral.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSURL *imageURL

  • Indication if support for a peripheral has been discontinued. Peripherals are marked as disabled instead of removed so that historical records can continue to be associated with the peripheral that created them.

    If a peripheral is disabled, it should not be displayed to the user when selecting a new peripheral.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int disabled;

  • Name of the peripheral comprised of the the manufacturer name and model number.

    Declaration

    Objective-C

    - (id)name;

  • The mechanism used to connect to the peripheral, used to identify the VLDPeripheral subclass.

    Declaration

    Objective-C

    + (id)connectionType;

  • Descriptive name for a type of peripheral.

    Declaration

    Objective-C

    + (id)nameForType:(id)type;

    Parameters

    type

    A value of VLDPeripheralType to get the name for.

  • List of supported VLDPeripheral objects.

    Declaration

    Objective-C

    + (id)supportedPeripherals;

  • Returns array containing set of supported peripherals of specified type.

    Declaration

    Objective-C

    + (id)peripheralsOfType:(id)type;

    Parameters

    type

    A value of VLDPeripheralType to get the list of peripherals for.

  • Returns record for peripheral

    Declaration

    Objective-C

    - (VLDRecord *)record;