com.squareup.square.models

Class DeviceCode

java.lang.Object

com.squareup.square.models.DeviceCode

public class DeviceCode
extends Object

This is a model class for DeviceCode type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceCode.Builder Class to build instances of DeviceCode.

Constructor Summary

Constructors

Constructor and Description
DeviceCode(String productType, String id, String name, String code, String deviceId, String locationId, String status, String pairBy, String createdAt, String statusChangedAt, String pairedAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCode() Getter for Code.
String	getCreatedAt() Getter for CreatedAt.
String	getDeviceId() Getter for DeviceId.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getName() Getter for Name.
String	getPairBy() Getter for PairBy.
String	getPairedAt() Getter for PairedAt.
String	getProductType() Getter for ProductType.
String	getStatus() Getter for Status.
String	getStatusChangedAt() Getter for StatusChangedAt.
int	hashCode()
DeviceCode.Builder	toBuilder() Builds a new DeviceCode.Builder object.
String	toString() Converts this DeviceCode into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceCode

public DeviceCode(String productType,
                  String id,
                  String name,
                  String code,
                  String deviceId,
                  String locationId,
                  String status,
                  String pairBy,
                  String createdAt,
                  String statusChangedAt,
                  String pairedAt)

Initialization constructor.

Parameters:

productType - String value for productType.

id - String value for id.

name - String value for name.

code - String value for code.

deviceId - String value for deviceId.

locationId - String value for locationId.

status - String value for status.

pairBy - String value for pairBy.

createdAt - String value for createdAt.

statusChangedAt - String value for statusChangedAt.

pairedAt - String value for pairedAt.

Method Detail

getId

public String getId()

Getter for Id. The unique id for this device code.

Returns:

Returns the String

getName

public String getName()

Getter for Name. An optional user-defined name for the device code.

Returns:

Returns the String

getCode

public String getCode()

Getter for Code. The unique code that can be used to login.

Returns:

Returns the String

getDeviceId

public String getDeviceId()

Getter for DeviceId. The unique id of the device that used this code. Populated when the device is paired up.

Returns:

Returns the String

getProductType

public String getProductType()

Getter for ProductType.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The location assigned to this code.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. DeviceCode.Status enum.

Returns:

Returns the String

getPairBy

public String getPairBy()

Getter for PairBy. When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. When this DeviceCode was created. Timestamp in RFC 3339 format.

Returns:

Returns the String

getStatusChangedAt

public String getStatusChangedAt()

Getter for StatusChangedAt. When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.

Returns:

Returns the String

getPairedAt

public String getPairedAt()

Getter for PairedAt. When this DeviceCode was paired. Timestamp in RFC 3339 format.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this DeviceCode into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public DeviceCode.Builder toBuilder()

Builds a new DeviceCode.Builder object. Creates the instance with the state of the current model.

Returns:

a new DeviceCode.Builder object