Samsung Health Data SDK/com.samsung.android.sdk.health.data.request/AggregateRequest

AggregateRequest

class AggregateRequest<T : Any> : Parcelable

Represents a request for an aggregation query over a period of time by applying aggregate operations, such as TOTAL, LAST, MIN and MAX.

Available aggregation operations differ by data type. See a data type's available aggregate operations in AggregateOperation. For example, NutritionType provides the TOTAL_CALORIES operation.

This request can include filters, such as the source and time filters. For example, if both of the following conditions have been applied for an aggregate request:

A specific time is set with LocalTimeFilter.
Samsung Health is set as the data source with AggregateSourceFilter.

The following sample retrieves aggregated data ? in this case, the total count of real steps:

suspend fun readStepsData() {
     val healthDataStore = HealthDataService.getStore(context)
     val readRequest = DataType.StepsType.TOTAL.requestBuilder
         // set some filters or conditions
         .build()

     // make asynchronous call for result
     val result = healthDataStore.aggregateData(readRequest)
     // process data
}

Since

1.0.0

Types

AllSourceLocalDateBuilder

class AllSourceLocalDateBuilder<T : Any> : AggregateRequest.Builder<T>

A local date time builder for all data sources to create an AggregateRequest instance.

Builder

interface Builder<T : Any>

The interface of the builder for creating an AggregateRequest.

DualTimeBuilder

class DualTimeBuilder<T : Any> : AggregateRequest.Builder<T>

A dual time builder to create an AggregateRequest instance.

LocalDateBuilder

class LocalDateBuilder<T : Any> : AggregateRequest.Builder<T>

A local date builder to create an AggregateRequest instance.

LocalTimeBuilder

class LocalTimeBuilder<T : Any> : AggregateRequest.Builder<T>

A local time builder to create an AggregateRequest instance.

Properties

dataType

val dataType: DataType

The data type of this request.

instantTimeFilter

val instantTimeFilter: InstantTimeFilter?

The time filter of this request as an InstantTimeFilter.

instantTimeGroup

val instantTimeGroup: InstantTimeGroup?

The time group of this request as an InstantTimeGroup.

localTimeFilter

val localTimeFilter: LocalTimeFilter?

The time filter of this request as a LocalTimeFilter.

localTimeGroup

val localTimeGroup: LocalTimeGroup?

The time group of this request as a LocalTimeGroup.

ordering

val ordering: Ordering?

The ordering of the response for this request.

pageSize

val pageSize: Int?

The page size of the response for this request, which means the size of the data in one result page.

pageToken

val pageToken: String?

The page token of the response for this request.

sourceFilter

val sourceFilter: AggregateSourceFilter?

The source filter of this request.

targetOperation

val targetOperation: AggregateOperation<*, *>

Essential Cookies

These cookies are essential as they enable you to move around the website. This category cannot be disabled.

Analytical/Performance Cookies

These cookies collect information about how you use our website. for example which pages you visit most often. All information these cookies collect is used to improve how the website works.

Functionality Cookies

These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and tailor the website to provide enhanced features and content for you.