Added in API level 34

RecordIdFilter


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

Inherited methods

Public methods

fromClientRecordId

Added in API level 34
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.

fromId

Added in API level 34
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(List, Executor, OutcomeReceiver) This value cannot be null.

Returns
RecordIdFilter Object of RecordIdFilter This value cannot be null.

getClientRecordId

Added in API level 34
public String getClientRecordId ()

Returns
String Client record identifier This value may be null.

getId

Added in API level 34
public String getId ()

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

getRecordType

Added in API level 34
public Class<? extends Record> getRecordType ()

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