HERE iOS SDK Developer's Guide

NMACustomLocationParameters

Class Summary

class NMACustomLocationParameters

Derived from: NSObject

Parameters used to filter the results of location requests made using the NMACustomLocationManager.

Deprecated: This class is deprecated as of NMA SDK 3.3. Please use CLE2 instead. In CLE2, attributes can be matched using simple expressions in NMACLE2AttributeRequest or with setQuery from any NMACLE2Request.

Include: NMAKit.framework/headers/NMACustomLocationParameters.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMACustomLocationParameters

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NSString *  customAttributeQuery

Deprecated: This property is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

The query string used to filter the results based on custom location attributes

[readable, writable, assign] NSString *  query

Deprecated: This property is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

The query string used to filter the results based on the predefined location attributes

[readable, writable, assign] NSUInteger  resultLimit

Deprecated: This property is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

The maximum number of locations to return

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) addCondition:( NMACustomLocationCondition ) condition withAttribute:( NMACustomLocationAttribute ) attribute value:(NSString *) value operator:( NMACustomLocationOperator ) oper

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2's setQuery instead.

Adds a condition to the query string

-(void) addCondition:( NMACustomLocationCondition ) condition withCustomAttribute:(NSString *) attribute value:(NSString *) value operator:( NMACustomLocationOperator ) oper

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2's setQuery instead.

Adds a condition to the custom attribute query string

Class Details

Parameters used to filter the results of location requests made using the NMACustomLocationManager.

Parameters can be used to narrow the results of custom location requests by comparing the attributes of the locations to specified values in different ways. These comparisons are called "conditions"; a condition may be placed upon one of the predefined attributes (NMACustomLocationAttribute) or on a custom attribute specific to the location set.

Parameters may also be used to limit the number of results returned by a request.

Note:

Parameters are optional and may be neglected in any location request.

Deprecated: This class is deprecated as of NMA SDK 3.3. Please use CLE2 instead. In CLE2, attributes can be matched using simple expressions in NMACLE2AttributeRequest or with setQuery from any NMACLE2Request.

Public Property Details

[readable, writable, assign] NSString * customAttributeQuery

Deprecated: This property is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

The query string used to filter the results based on custom location attributes.

The query string is made up of zero or more conditions. The string may set directly or built one condition at a time using the addCondition:withCustomAttribute:value:operator: method.

[readable, writable, assign] NSString * query

Deprecated: This property is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

The query string used to filter the results based on the predefined location attributes.

The query string is made up of zero or more conditions. The string may set directly or built one condition at a time using the addCondition:withAttribute:value:operator: method.

[readable, writable, assign] NSUInteger resultLimit

Deprecated: This property is deprecated as of NMA SDK 3.3. Please use CLE2 instead.

The maximum number of locations to return.

Instance Method Details

-(void) addCondition:( NMACustomLocationCondition ) condition withAttribute:( NMACustomLocationAttribute ) attribute value:(NSString *) value operator:( NMACustomLocationOperator ) oper

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2's setQuery instead.

Adds a condition to the query string.

Parameters:

  • condition

    The type of condition to add, from NMACustomLocationCondition.

  • attribute

    The attribute to filter, from NMACustomLocationAttribute.

  • value

    The value to compare against in the condition.

  • oper

    The operator used to combine the new condition with the existing conditions. Has no effect if this is the first condition.

-(void) addCondition:( NMACustomLocationCondition ) condition withCustomAttribute:(NSString *) attribute value:(NSString *) value operator:( NMACustomLocationOperator ) oper

Deprecated: This method is deprecated as of NMA SDK 3.3. Please use CLE2's setQuery instead.

Adds a condition to the custom attribute query string.

Parameters:

  • condition

    The type of condition to add, from NMACustomLocationCondition.

  • attribute

    The attribute to filter.

  • value

    The value to compare against in the condition.

  • oper

    The operator used to combine the new condition with the existing conditions. Has no effect if this is the first condition.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.