Class: Device

device.Device

new Device()

Source:

Methods

(static) Device#getAllowStoreAndForward() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) Device#getBuildNumber() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getBuildType() → {device.BuildType}

Get the field value
Source:
Returns:
Type
device.BuildType

(static) Device#getCpuId() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Device#getDeviceCertificate() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Device#getDeviceTypeName() → {String}

Get the field value The type of device. Possible values are "GOLDLEAF" (Station), "LEAFCUTTER" (Mobile), "MAPLECUTTER" (Mini), "CLOVER_GO" (Clover Go), or "OTHER" (Unknown).
Source:
Returns:
Type
String

(static) Device#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) Device#getImei() → {String}

Get the field value The IMEI of the device
Source:
Returns:
Type
String

(static) Device#getImsi() → {String}

Get the field value The IMSI of the SIM in the device (if present)
Source:
Returns:
Type
String

(static) Device#getMaxOfflineDays() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getMerchant() → {base.Reference}

Get the field value
Source:
Returns:
Type
base.Reference

(static) Device#getModel() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Device#getName() → {String}

Get the field value Name of the device (if entered)
Source:
Returns:
Type
String

(static) Device#getOfflinePayments() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) Device#getOfflinePaymentsAll() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) Device#getOfflinePaymentsLimit() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsLimitDefault() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsMaxLimit() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsMaxTotalPaymentsLimit() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsPromptThreshold() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsPromptThresholdDefault() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsTotalPaymentsLimit() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOfflinePaymentsTotalPaymentsLimitDefault() → {Number}

Get the field value
Source:
Returns:
must be a long integer
Type
Number

(static) Device#getOrderPrefix() → {String}

Get the field value A prefix that will be applied to order numbers. This is useful if the merchant and/or customer needs to track which device an order came from.
Source:
Returns:
Type
String

(static) Device#getPedCertificate() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Device#getPinDisabled() → {Boolean}

Get the field value Whether this device has PIN prompt disabled.
Source:
Returns:
Type
Boolean

(static) Device#getSecureId() → {String}

Get the field value
Source:
Returns:
Type
String

(static) Device#getSecureReports() → {Array.<base.Reference>}

Get the field value
Source:
Returns:
An array of
Type
Array.<base.Reference>

(static) Device#getSerial() → {String}

Get the field value The device's serial number.
Source:
Returns:
Type
String

(static) Device#getShowOfflinePayments() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) Device#getSimIccid() → {String}

Get the field value The ICCID of the SIM in the device (if present)
Source:
Returns:
Type
String

(static) Device#getTerminalPrefix() → {Null|Number}

Get the field value
Source:
Returns:
must be an integer
Type
Null | Number

(static) Device#setAllowStoreAndForward(allowStoreAndForward)

Set the field value
Parameters:
Name Type Description
allowStoreAndForward Boolean
Source:

(static) Device#setBuildNumber(buildNumber)

Set the field value
Parameters:
Name Type Description
buildNumber Number must be a long integer
Source:

(static) Device#setBuildType(buildType)

Set the field value
Parameters:
Name Type Description
buildType device.BuildType
Source:

(static) Device#setCpuId(cpuId)

Set the field value
Parameters:
Name Type Description
cpuId String
Source:

(static) Device#setDeviceCertificate(deviceCertificate)

Set the field value
Parameters:
Name Type Description
deviceCertificate String
Source:

(static) Device#setDeviceTypeName(deviceTypeName)

Set the field value The type of device. Possible values are "GOLDLEAF" (Station), "LEAFCUTTER" (Mobile), "MAPLECUTTER" (Mini), "CLOVER_GO" (Clover Go), or "OTHER" (Unknown).
Parameters:
Name Type Description
deviceTypeName String
Source:

(static) Device#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) Device#setImei(imei)

Set the field value The IMEI of the device
Parameters:
Name Type Description
imei String
Source:

(static) Device#setImsi(imsi)

Set the field value The IMSI of the SIM in the device (if present)
Parameters:
Name Type Description
imsi String
Source:

(static) Device#setMaxOfflineDays(maxOfflineDays)

Set the field value
Parameters:
Name Type Description
maxOfflineDays Number must be a long integer
Source:

(static) Device#setMerchant(merchant)

Set the field value
Parameters:
Name Type Description
merchant base.Reference
Source:

(static) Device#setModel(model)

Set the field value
Parameters:
Name Type Description
model String
Source:

(static) Device#setName(name)

Set the field value Name of the device (if entered)
Parameters:
Name Type Description
name String
Source:

(static) Device#setOfflinePayments(offlinePayments)

Set the field value
Parameters:
Name Type Description
offlinePayments Boolean
Source:

(static) Device#setOfflinePaymentsAll(offlinePaymentsAll)

Set the field value
Parameters:
Name Type Description
offlinePaymentsAll Boolean
Source:

(static) Device#setOfflinePaymentsLimit(offlinePaymentsLimit)

Set the field value
Parameters:
Name Type Description
offlinePaymentsLimit Number must be a long integer
Source:

(static) Device#setOfflinePaymentsLimitDefault(offlinePaymentsLimitDefault)

Set the field value
Parameters:
Name Type Description
offlinePaymentsLimitDefault Number must be a long integer
Source:

(static) Device#setOfflinePaymentsMaxLimit(offlinePaymentsMaxLimit)

Set the field value
Parameters:
Name Type Description
offlinePaymentsMaxLimit Number must be a long integer
Source:

(static) Device#setOfflinePaymentsMaxTotalPaymentsLimit(offlinePaymentsMaxTotalPaymentsLimit)

Set the field value
Parameters:
Name Type Description
offlinePaymentsMaxTotalPaymentsLimit Number must be a long integer
Source:

(static) Device#setOfflinePaymentsPromptThreshold(offlinePaymentsPromptThreshold)

Set the field value
Parameters:
Name Type Description
offlinePaymentsPromptThreshold Number must be a long integer
Source:

(static) Device#setOfflinePaymentsPromptThresholdDefault(offlinePaymentsPromptThresholdDefault)

Set the field value
Parameters:
Name Type Description
offlinePaymentsPromptThresholdDefault Number must be a long integer
Source:

(static) Device#setOfflinePaymentsTotalPaymentsLimit(offlinePaymentsTotalPaymentsLimit)

Set the field value
Parameters:
Name Type Description
offlinePaymentsTotalPaymentsLimit Number must be a long integer
Source:

(static) Device#setOfflinePaymentsTotalPaymentsLimitDefault(offlinePaymentsTotalPaymentsLimitDefault)

Set the field value
Parameters:
Name Type Description
offlinePaymentsTotalPaymentsLimitDefault Number must be a long integer
Source:

(static) Device#setOrderPrefix(orderPrefix)

Set the field value A prefix that will be applied to order numbers. This is useful if the merchant and/or customer needs to track which device an order came from.
Parameters:
Name Type Description
orderPrefix String
Source:

(static) Device#setPedCertificate(pedCertificate)

Set the field value
Parameters:
Name Type Description
pedCertificate String
Source:

(static) Device#setPinDisabled(pinDisabled)

Set the field value Whether this device has PIN prompt disabled.
Parameters:
Name Type Description
pinDisabled Boolean
Source:

(static) Device#setSecureId(secureId)

Set the field value
Parameters:
Name Type Description
secureId String
Source:

(static) Device#setSecureReports(secureReports)

Set the field value
Parameters:
Name Type Description
secureReports Array.<base.Reference> An array of
Source:

(static) Device#setSerial(serial)

Set the field value The device's serial number.
Parameters:
Name Type Description
serial String
Source:

(static) Device#setShowOfflinePayments(showOfflinePayments)

Set the field value
Parameters:
Name Type Description
showOfflinePayments Boolean
Source:

(static) Device#setSimIccid(simIccid)

Set the field value The ICCID of the SIM in the device (if present)
Parameters:
Name Type Description
simIccid String
Source:

(static) Device#setTerminalPrefix(terminalPrefix)

Set the field value
Parameters:
Name Type Description
terminalPrefix Null | Number must be an integer
Source: