VLDPeripheral Class Reference

Inherits from VLDModel : NSObject
Declared in VLDPeripheral.h

Overview

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.

  peripheralID

A unique identifer for a particular peripheral model.

@property (nonatomic, assign) NSUInteger peripheralID

Discussion

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.

Declared In

VLDPeripheral.h

  type

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

@property (nonatomic, assign) VLDPeripheralType type

Discussion

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

Declared In

VLDPeripheral.h

  model

Model number of the peripheral.

@property (nonatomic, copy) NSString *model

Discussion

Model number of the peripheral.

Declared In

VLDPeripheral.h

  manufacturer

Manufacturer name of the peripheral.

@property (nonatomic, copy) NSString *manufacturer

Discussion

Manufacturer name of the peripheral.

Declared In

VLDPeripheral.h

  imageURL

URL for an image of the peripheral.

@property (nonatomic, strong) NSURL *imageURL

Discussion

URL for an image of the peripheral.

Declared In

VLDPeripheral.h

  disabled

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.

@property (nonatomic, assign) BOOL disabled

Discussion

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.

Declared In

VLDPeripheral.h

– name

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

- (NSString *)name

Discussion

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

Declared In

VLDPeripheral.h

+ connectionType

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

+ (NSString *)connectionType

Discussion

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

Declared In

VLDPeripheral.h

+ nameForType:

Descriptive name for a type of peripheral.

+ (NSString *)nameForType:(VLDPeripheralType)type

Parameters

type

A value of VLDPeripheralType to get the name for.

Discussion

Descriptive name for a type of peripheral.

Declared In

VLDPeripheral.h

+ supportedPeripherals

List of supported VLDPeripheral objects.

+ (NSArray *)supportedPeripherals

Discussion

List of supported VLDPeripheral objects.

Declared In

VLDPeripheral.h

+ peripheralsOfType:

Returns array containing set of supported peripherals of specified type.

+ (NSArray *)peripheralsOfType:(VLDPeripheralType)type

Parameters

type

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

Discussion

Returns array containing set of supported peripherals of specified type.

Declared In

VLDPeripheral.h