JSDoc: Class: Device

new Device()

Source:

device/Device.js, line 14

Methods

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

Get the field value

Source:

device/Device.js, line 655

Returns:

Type: Boolean

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

Get the field value

Source:

device/Device.js, line 226

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 262

Returns:

Type: device.BuildType

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

Get the field value

Source:

device/Device.js, line 691

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 280

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 361

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:

device/Device.js, line 400

Returns:

Type: String

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

Get the field value Unique identifier

Source:

device/Device.js, line 70

Returns:

Type: String

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

Get the field value The IMEI of the device

Source:

device/Device.js, line 301

Returns:

Type: String

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

Get the field value The IMSI of the SIM in the device (if present)

Source:

device/Device.js, line 322

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 637

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 127

Returns:

Type: base.Reference

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

Get the field value

Source:

device/Device.js, line 109

Returns:

Type: String

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

Get the field value Name of the device (if entered)

Source:

device/Device.js, line 91

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 439

Returns:

Type: Boolean

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

Get the field value

Source:

device/Device.js, line 457

Returns:

Type: Boolean

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

Get the field value

Source:

device/Device.js, line 475

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 529

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 583

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 601

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 493

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 547

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 511

Returns:

must be a long integer

Type: Number

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

Get the field value

Source:

device/Device.js, line 565

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:

device/Device.js, line 148

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 379

Returns:

Type: String

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

Get the field value Whether this device has PIN prompt disabled.

Source:

device/Device.js, line 421

Returns:

Type: Boolean

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

Get the field value

Source:

device/Device.js, line 244

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 673

Returns:

An array of

Type: Array.<base.Reference>

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

Get the field value The device's serial number.

Source:

device/Device.js, line 208

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 619

Returns:

Type: Boolean

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

Get the field value The ICCID of the SIM in the device (if present)

Source:

device/Device.js, line 343

Returns:

Type: String

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

Get the field value The merchant device's terminal Id. FD-IPG sets the merchant_device terminal Id for LATAM devices

Source:

device/Device.js, line 169

Returns:

Type: String

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

Get the field value

Source:

device/Device.js, line 187

Returns:

must be an integer

Type: Null | Number

(static) Device#setAllowStoreAndForward(allowStoreAndForward)

Set the field value

Parameters:

Name	Type	Description
`allowStoreAndForward`	Boolean

Source:

device/Device.js, line 646

(static) Device#setBuildNumber(buildNumber)

Set the field value

Parameters:

Name	Type	Description
`buildNumber`	Number	must be a long integer

Source:

device/Device.js, line 217

(static) Device#setBuildType(buildType)

Set the field value

Parameters:

Name	Type	Description
`buildType`	device.BuildType

Source:

device/Device.js, line 253

(static) Device#setBundleIndicator(bundleIndicator)

Set the field value

Parameters:

Name	Type	Description
`bundleIndicator`	String

Source:

device/Device.js, line 682

(static) Device#setCpuId(cpuId)

Set the field value

Parameters:

Name	Type	Description
`cpuId`	String

Source:

device/Device.js, line 271

(static) Device#setDeviceCertificate(deviceCertificate)

Set the field value

Parameters:

Name	Type	Description
`deviceCertificate`	String

Source:

device/Device.js, line 352

(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:

device/Device.js, line 390

(static) Device#setId(id)

Set the field value Unique identifier

Parameters:

Name	Type	Description
`id`	String

Source:

device/Device.js, line 60

(static) Device#setImei(imei)

Set the field value The IMEI of the device

Parameters:

Name	Type	Description
`imei`	String

Source:

device/Device.js, line 291

(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:

device/Device.js, line 312

(static) Device#setMaxOfflineDays(maxOfflineDays)

Set the field value

Parameters:

Name	Type	Description
`maxOfflineDays`	Number	must be a long integer

Source:

device/Device.js, line 628

(static) Device#setMerchant(merchant)

Set the field value

Parameters:

Name	Type	Description
`merchant`	base.Reference

Source:

device/Device.js, line 118

(static) Device#setModel(model)

Set the field value

Parameters:

Name	Type	Description
`model`	String

Source:

device/Device.js, line 100

(static) Device#setName(name)

Set the field value Name of the device (if entered)

Parameters:

Name	Type	Description
`name`	String

Source:

device/Device.js, line 81

(static) Device#setOfflinePayments(offlinePayments)

Set the field value

Parameters:

Name	Type	Description
`offlinePayments`	Boolean

Source:

device/Device.js, line 430

(static) Device#setOfflinePaymentsAll(offlinePaymentsAll)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsAll`	Boolean

Source:

device/Device.js, line 448

(static) Device#setOfflinePaymentsLimit(offlinePaymentsLimit)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsLimit`	Number	must be a long integer

Source:

device/Device.js, line 466

(static) Device#setOfflinePaymentsLimitDefault(offlinePaymentsLimitDefault)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsLimitDefault`	Number	must be a long integer

Source:

device/Device.js, line 520

(static) Device#setOfflinePaymentsMaxLimit(offlinePaymentsMaxLimit)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsMaxLimit`	Number	must be a long integer

Source:

device/Device.js, line 574

(static) Device#setOfflinePaymentsMaxTotalPaymentsLimit(offlinePaymentsMaxTotalPaymentsLimit)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsMaxTotalPaymentsLimit`	Number	must be a long integer

Source:

device/Device.js, line 592

(static) Device#setOfflinePaymentsPromptThreshold(offlinePaymentsPromptThreshold)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsPromptThreshold`	Number	must be a long integer

Source:

device/Device.js, line 484

(static) Device#setOfflinePaymentsPromptThresholdDefault(offlinePaymentsPromptThresholdDefault)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsPromptThresholdDefault`	Number	must be a long integer

Source:

device/Device.js, line 538

(static) Device#setOfflinePaymentsTotalPaymentsLimit(offlinePaymentsTotalPaymentsLimit)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsTotalPaymentsLimit`	Number	must be a long integer

Source:

device/Device.js, line 502

(static) Device#setOfflinePaymentsTotalPaymentsLimitDefault(offlinePaymentsTotalPaymentsLimitDefault)

Set the field value

Parameters:

Name	Type	Description
`offlinePaymentsTotalPaymentsLimitDefault`	Number	must be a long integer

Source:

device/Device.js, line 556

(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:

device/Device.js, line 138

(static) Device#setPedCertificate(pedCertificate)

Set the field value

Parameters:

Name	Type	Description
`pedCertificate`	String

Source:

device/Device.js, line 370

(static) Device#setPinDisabled(pinDisabled)

Set the field value Whether this device has PIN prompt disabled.

Parameters:

Name	Type	Description
`pinDisabled`	Boolean

Source:

device/Device.js, line 411

(static) Device#setSecureId(secureId)

Set the field value

Parameters:

Name	Type	Description
`secureId`	String

Source:

device/Device.js, line 235

(static) Device#setSecureReports(secureReports)

Set the field value

Parameters:

Name	Type	Description
`secureReports`	Array.<base.Reference>	An array of

Source:

device/Device.js, line 664

(static) Device#setSerial(serial)

Set the field value The device's serial number.

Parameters:

Name	Type	Description
`serial`	String

Source:

device/Device.js, line 198

(static) Device#setShowOfflinePayments(showOfflinePayments)

Set the field value

Parameters:

Name	Type	Description
`showOfflinePayments`	Boolean

Source:

device/Device.js, line 610

(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:

device/Device.js, line 333

(static) Device#setTerminalId(terminalId)

Set the field value The merchant device's terminal Id. FD-IPG sets the merchant_device terminal Id for LATAM devices

Parameters:

Name	Type	Description
`terminalId`	String

Source:

device/Device.js, line 159

(static) Device#setTerminalPrefix(terminalPrefix)

Set the field value

Parameters:

Name	Type	Description
`terminalPrefix`	Null \| Number	must be an integer

Source:

device/Device.js, line 178