DeviceDataTypeSource


class DeviceDataTypeSource : Parcelable
kotlin.Any
   ↳ android.health.connect.DeviceDataTypeSource

A data type provided by a device.

Summary

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Class<out Record!>

Returns the data type provided by the device.

Int

Returns the symptom type provided by the device.

Int

Returns a hash code value for the object.

Boolean

Returns whether this data type is currently available from the device.

Boolean

Returns whether the user has enabled this data type for the device.

static DeviceDataTypeSource
ofDataType(dataType: Class<out Record!>, isAvailable: Boolean, isUserEnabled: Boolean)

Create a source of data of a particular data type that is provided by a device.

static DeviceDataTypeSource
ofSymptomType(symptomType: Int, isAvailable: Boolean, isUserEnabled: Boolean)

Create a source of SymptomRecord that is provided by a device.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<DeviceDataTypeSource!>

Public methods

describeContents

Added in API level 37
fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 37
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getDataType

fun getDataType(): Class<out Record!>

Returns the data type provided by the device.

Return
Class<out Record!> This value cannot be null.

getSymptomType

fun getSymptomType(): Int

Returns the symptom type provided by the device.

Returns SymptomRecord.SYMPTOM_TYPE_UNKNOWN if this source is not for a SymptomRecord.

Return
Int Value is one of the following:

hashCode

Added in API level 37
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

isAvailable

fun isAvailable(): Boolean

Returns whether this data type is currently available from the device.

This may be false if, for example, the device is disconnected or out of range.

isUserEnabled

fun isUserEnabled(): Boolean

Returns whether the user has enabled this data type for the device.

ofDataType

static fun ofDataType(
    dataType: Class<out Record!>,
    isAvailable: Boolean,
    isUserEnabled: Boolean
): DeviceDataTypeSource

Create a source of data of a particular data type that is provided by a device. For the SymptomRecord data type, please us ofSymptomType.

Parameters
dataType Class<out Record!>: The data type provided by the device.
This value cannot be null.
isAvailable Boolean: Whether this data type is currently available from the device. This may be false if for example, the device is disconnected or out of range.
isUserEnabled Boolean: Whether the user has enabled this data type for the device.
Return
DeviceDataTypeSource This value cannot be null.

ofSymptomType

static fun ofSymptomType(
    symptomType: Int,
    isAvailable: Boolean,
    isUserEnabled: Boolean
): DeviceDataTypeSource

Create a source of SymptomRecord that is provided by a device.

Parameters
symptomType Int: The symptom type provided by this device.
Value is one of the following:
isAvailable Boolean: Whether this data type is currently available from the device. This may be false if for example, the device is disconnected or out of range.
isUserEnabled Boolean: Whether the user has enabled this data type for the device.
Return
DeviceDataTypeSource This value cannot be null.

toString

Added in API level 37
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 37
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

static val CREATOR: Parcelable.Creator<DeviceDataTypeSource!>