Class: PostcodeAnywhere::CapturePlus::SearchResult

Inherits:
ModelBase
  • Object
show all
Defined in:
lib/postcode_anywhere/capture_plus/search_result.rb

Instance Attribute Summary collapse

Attributes inherited from ModelBase

#attrs

Method Summary

Methods inherited from ModelBase

attr_reader, define_attribute_method, define_predicate_method, #initialize, object_attr_reader, predicate_attr_reader

Constructor Details

This class inherits a constructor from PostcodeAnywhere::ModelBase

Instance Attribute Details

#cursor ⇒ Object (readonly)

A zero-based position in the Text response indicating the suggested position of the cursor if this item is selected. A -1 response indicates no suggestion is available. 0 Example: true



24
25
26
 
# File 'lib/postcode_anywhere/capture_plus/search_result.rb', line 24

def cursor
  @cursor
end

#description ⇒ Object (readonly)

Descriptive information about the found item, typically if it’s a container. Example: 102 Streets



28
29
30
 
# File 'lib/postcode_anywhere/capture_plus/search_result.rb', line 28

def description
  @description
end

#highlight ⇒ Object (readonly)

A list of number ranges identifying the characters to highlight in the Text response (zero-based start position and end). Example: 0-2,6-4



17
18
19
 
# File 'lib/postcode_anywhere/capture_plus/search_result.rb', line 17

def highlight
  @highlight
end

#id ⇒ Object (readonly)

The Id to be used as the LastId with the Find method. Example: GBR|ST|27299|3739|6|0|0|



8
9
10
 
# File 'lib/postcode_anywhere/capture_plus/search_result.rb', line 8

def id
  @id
end

#next ⇒ Object (readonly)

The next step of the search process. Values:

- Find
- Retrieve
- None

Example: Retrieve



36
37
38
 
# File 'lib/postcode_anywhere/capture_plus/search_result.rb', line 36

def next
  @next
end

#text ⇒ Object (readonly)

The found item. Example: High Street, London



12
13
14
 
# File 'lib/postcode_anywhere/capture_plus/search_result.rb', line 12

def text
  @text
end