RecordIdFilter

Kotlin |Java

public class RecordIdFilter
extends Object

java.lang.Object
↳	android.health.connect.RecordIdFilter

A class to represent filtering based on record ID or client ID.

Summary

Public methods
`static RecordIdFilter`	`fromClientRecordId(Class<? extends Record> recordType, String clientRecordId)` Creates an instance of Record id filter based on client record id.
`static RecordIdFilter`	`fromId(Class<? extends Record> recordType, String id)` Creates an instance of Record id filter based on record id.
`String`	`getClientRecordId()`
`String`	`getId()`
`Class<? extends Record>`	`getRecordType()`

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

public static RecordIdFilter fromClientRecordId (Class<? extends Record> recordType, 
                String clientRecordId)

Creates an instance of Record id filter based on client record id.

Note: this only works when reading own records, using client record ids to read records inserted by another app will return no result.

Parameters
`recordType`	`Class`: Record class for which the client record id must be set. This value cannot be `null`.
`clientRecordId`	`String`: Client identifier that was set while inserting the record. This value cannot be `null`.

Returns
`RecordIdFilter`	Object of `RecordIdFilter` This value cannot be `null`.

public static RecordIdFilter fromId (Class<? extends Record> recordType, 
                String id)

Creates an instance of Record id filter based on record id.

Parameters
`recordType`	`Class`: Record class for which the id must be set. This value cannot be `null`.
`id`	`String`: Identifier generated by the platform and returned by `HealthConnectManager.insertRecords` This value cannot be `null`.

Returns
`RecordIdFilter`	Object of `RecordIdFilter` This value cannot be `null`.

public String getClientRecordId ()

Returns
`String`	Client record identifier. This value may be `null`.

public String getId ()

Returns
`String`	Identifier given by the platform. This value may be `null`.

public Class<? extends Record> getRecordType ()

Returns
`Class<? extends Record>`	Record class for this identifier. This value cannot be `null`.