AdvancedDataInquiry Class Reference

Inherits from DefaultConfiguration : NSObject
Declared in AdvancedDataInquiry.h

Overview

Advanced Data Inquiry allows querying measurement data (values, location and attributes) for a single account using advanced filtering and sorting.

– init

- (id)init

– initAdvancedDataInquiryWithDefaults

Creates custom instance of the class AdvancedDataEnquiry

- (id)initAdvancedDataInquiryWithDefaults

Return Value

an instance of the class AdvancedDataEnquiry

Declared In

AdvancedDataInquiry.h

– addGatewayId:

Add a gateway id that is requested for the data in the report.

- (void)addGatewayId:(NSString *)gatewayId

Parameters

gatewayId

The gateway identifier for gateway data to be included in the report.

Declared In

AdvancedDataInquiry.h

– addDeviceId:

Add a device id that is requested for the data in the report.

- (void)addDeviceId:(NSString *)deviceId

Parameters

deviceId

The device identifier for device data to be included in the report.

Declared In

AdvancedDataInquiry.h

– addComponentId:

Add a component id that is requested for the data in the report.

- (void)addComponentId:(NSString *)componentId

Parameters

componentId

The component identifier for component data to be included in the report.

Declared In

AdvancedDataInquiry.h

– setStartTimestamp:

Set the start time for query data in be included in the report.

- (void)setStartTimestamp:(long)timestamp

Parameters

timestamp

time in milliseconds since epoch time.

Declared In

AdvancedDataInquiry.h

– setEndTimestamp:

Set the end time for query data in be included in the report.

- (void)setEndTimestamp:(long)timestamp

Parameters

timestamp

time in milliseconds since epoch time.

Declared In

AdvancedDataInquiry.h

– addReturnedMeasureAttributes:

Add a requested attribute to a list of attributes that will be return for each measurement.

- (void)addReturnedMeasureAttributes:(NSString *)attribute

Parameters

attribute

The attribute to add to the list of attributes that will be part of the request.

Declared In

AdvancedDataInquiry.h

– setShowMeasureLocation:

Request for location (lat, long, alt) as part of each returned measurement.

- (void)setShowMeasureLocation:(BOOL)measureLocation

Parameters

measureLocation

if true returns location.

Declared In

AdvancedDataInquiry.h

– addDevCompAttributeFilter:

Append device comp attribute filter to list. Filters by device and/or component attributes.

- (void)addDevCompAttributeFilter:(AttributeFilter *)attributeFilter

Parameters

attributeFilter

The filter to filtered by

Declared In

AdvancedDataInquiry.h

– addMeasurementAttributeFilter:

Append measurement attribute filter to list. Filters by measurement attributes.

- (void)addMeasurementAttributeFilter:(AttributeFilter *)attributeFilter

Parameters

attributeFilter

The filter to filtered by

Declared In

AdvancedDataInquiry.h

– addValueFilter:

Append avalue filter to list. Filters by measurement values.

- (void)addValueFilter:(AttributeFilter *)attributeFilter

Parameters

attributeFilter

The filter to filtered by

Declared In

AdvancedDataInquiry.h

– setComponentRowLimit:

Limits the number of records returned for each component in the report.

- (void)setComponentRowLimit:(NSInteger)rowLimit

Parameters

rowLimit

the number of row that will be returned.

Declared In

AdvancedDataInquiry.h

– setCountOnly:

Setting to true will return the number of rows that would have returned from this report.

- (void)setCountOnly:(BOOL)countOnly

Parameters

countOnly

true will return number of rows.

Declared In

AdvancedDataInquiry.h

– addSortInfo:WithValue:

Append sort key-value pair to list for query to be sorted by

- (void)addSortInfo:(NSString *)name WithValue:(NSString *)value

Parameters

name

The name of the key
value

The value of the key

Declared In

AdvancedDataInquiry.h

– request

Starts a request for the report.

- (CloudResponse *)request

Return Value

For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.

Declared In

AdvancedDataInquiry.h