TNEntitySearchParams

@objcMembers
open class TNEntitySearchParams : NSObject

Undocumented

  • Query which is used for search

    Declaration

    Swift

    public var searchQuery: String

  • Current vehicle position (CVP), If parameter anchor is not set, location will be used as the search anchor. (Required)

    Declaration

    Swift

    public var location: TNEntityGeoPoint?

  • Coordinates of the anchor point for the search. (Optional)

    Declaration

    Swift

    public var anchor: TNEntityGeoPoint?

  • Max number of entities that will be returned from request

    Declaration

    Swift

    public var limit: Int

  • Array of filters applied to search

    Declaration

    Swift

    public var filters: TNEntitySearchFilter?

  • Search options

    Declaration

    Swift

    public var searchOptions: TNEntitySearchOptions?

  • Context for getting next page. Received in response

    Declaration

    Swift

    public var pageContext: String?

  • Parameters to specify facet related search result

    Declaration

    Swift

    public var facetParameters: TNEntityFacetParameters?

Validate

  • Validates all properties.

    Declaration

    Swift

    public func validate() -> (isValid: Bool, message: String)

    Return Value

    Tuple (isValid: Bool, message: String).

    • isValid - is true if validation was successful
    • message - contains error string if validation failed