SCPReader

Objective-C


@interface SCPReader : NSObject <SCPJSONDecodable>

Swift

class Reader : NSObject, JSONDecodable

Information about a reader that has been discovered or connected to the SDK. Note some of the properties are specific to a certain device type and are labeled as such. If a property does not call out a specific device then it is applicable to all device types.

See

https://stripe.com/docs/terminal/readers

  • The IP address of the reader. (Verifone P400 only.)

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *ipAddress;

    Swift

    var ipAddress: String? { get }

  • The location ID of the reader. (Verifone P400 only.)

    See

    https://stripe.com/docs/api/terminal/locations

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *locationId;

    Swift

    var locationId: String? { get }

  • The networking status of the reader: either offline or online. Note that the Chipper 2X and the WisePad 3’s statuses will always be offline. (Verifone P400 only.)

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPReaderNetworkStatus status;

    Swift

    var status: ReaderNetworkStatus { get }

  • A custom label that may be given to a reader for easier identification. (Verifone P400 only.)

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *label;

    Swift

    var label: String? { get }

  • The reader’s battery level, represented as a boxed float in the range [0, 1]. If the reader does not have a battery, or the battery level is unknown, this value is nil. (Chipper 2X and WisePad 3 only.)

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *batteryLevel;

    Swift

    var batteryLevel: NSNumber? { get }

  • The Stripe unique identifier for the reader.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *stripeId;

    Swift

    var stripeId: String? { get }

  • The reader’s device type.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPDeviceType deviceType;

    Swift

    var deviceType: DeviceType { get }

  • True if this is a simulated reader.

    SCPDiscoveryConfiguration objects with simulated set to true produce simulated readers.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL simulated;

    Swift

    var simulated: Bool { get }

  • The reader’s serial number.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull serialNumber;

    Swift

    var serialNumber: String { get }

  • The reader’s current device software version, or nil if this information is unavailable.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *deviceSoftwareVersion;

    Swift

    var deviceSoftwareVersion: String? { get }

  • Unavailable

    You cannot directly instantiate this class.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    You cannot directly instantiate this class.

    Declaration

    Objective-C

    + (nonnull instancetype)new;