com.microstrategy.ushersdk

Class IotDeviceEntity

java.lang.Object

com.microstrategy.ushersdk.IotDeviceEntity

public abstract class IotDeviceEntity
extends java.lang.Object

The IotDeviceEntity abstract class wraps various properties related to an IoT device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IotDeviceEntity.Status Enumerations of IotDeviceEntity.Status.
static class	IotDeviceEntity.UserRole Enumerations of IotDeviceEntity.UserRole.

Method Summary

Modifier and Type	Method and Description
static com.microstrategy.ushersdk.IotDeviceEntity.Builder	builder() Returns the Builder object for the IotDeviceEntity abstract class.
abstract java.lang.String	iotId() Returns a String of the identification number of the IoT device.
abstract java.lang.String	nickName() Returns a String of the name of the IoT device.
abstract java.lang.String	partner2Id() Returns a String of the identification number of the secondary driver.
abstract OwnerEntity	primaryDriverEntity() Returns a OwnerEntity object, which wraps properties related to the driver of the IoT device, for the primary driver.
abstract java.util.List<OwnerEntity>	secondaryDriverEntityList() Returns a List of OwnerEntity objects, which wraps properties related to the driver of the IoT device, for the secondary drivers.
abstract IotDeviceEntity.Status	status() Returns an enumeration of the IotDeviceEntity.Status of the IoT device.
abstract IotDeviceEntity.UserRole	userRole() Returns an enumeration of the IotDeviceEntity.UserRole of the current user of the IoT device.
abstract long	userRoleUpdatedTs() Returns a long of the time in seconds at which the user role was updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

iotId

public abstract java.lang.String iotId()

Returns a String of the identification number of the IoT device.

Returns:

the identification number of the IoT device.

nickName

@Nullable
public abstract java.lang.String nickName()

Returns a String of the name of the IoT device. May be null.

Returns:

the name of the IoT device.

partner2Id

@Nullable
public abstract java.lang.String partner2Id()

Returns a String of the identification number of the secondary driver. May be null.

Returns:

the identification number of the secondary driver.

primaryDriverEntity

@Nullable
public abstract OwnerEntity primaryDriverEntity()

Returns a OwnerEntity object, which wraps properties related to the driver of the IoT device, for the primary driver. May be null.

Returns:

the OwnerEntity object.

secondaryDriverEntityList

@Nullable
public abstract java.util.List<OwnerEntity> secondaryDriverEntityList()

Returns a List of OwnerEntity objects, which wraps properties related to the driver of the IoT device, for the secondary drivers. May be null.

Returns:

the List of OwnerEntity objects for the secondary drivers.

status

public abstract IotDeviceEntity.Status status()

Returns an enumeration of the IotDeviceEntity.Status of the IoT device.

Returns:

the IotDeviceEntity.Status of the IoT device.

userRole

public abstract IotDeviceEntity.UserRole userRole()

Returns an enumeration of the IotDeviceEntity.UserRole of the current user of the IoT device.

Returns:

the IotDeviceEntity.UserRole of the current user of the IoT device.

userRoleUpdatedTs

public abstract long userRoleUpdatedTs()

Returns a long of the time in seconds at which the user role was updated.

Returns:

the time in seconds at which the user role was updated.

builder

public static com.microstrategy.ushersdk.IotDeviceEntity.Builder builder()

Returns the Builder object for the IotDeviceEntity abstract class.

Returns:

the Builder object for the IotDeviceEntity abstract class.