Class MMSearchRequester

Object
   |
   +--MMJSONRequester
         |
         +--MMSearchRequester

class MMSearchRequester

extends MMJSONRequester

Defined in MultimapAPI

Field Detail

error_code

String error_code

The error code produced by the last call to search().
Possible values:
• MM_API_ERROR_DATABASE_QUERY_FAILED
• MM_API_ERROR_DATA_SOURCE_NOT_PROVISIONED
• MM_API_ERROR_INSECURE_ACCESS_DENIED
• MM_API_ERROR_INTERNAL_ERROR
• MM_API_ERROR_NON_POST_ACCESS_DENIED
• MM_API_ERROR_REQUIRED_PARAMETERS_MISSING
• MM_API_ERROR_SECURE_ACCESS_DENIED
• MM_API_ERROR_SERVICE_NOT_PROVISIONED
• MM_API_ERROR_START_INDEX_GREATER_THAN_RESULT_SET_SIZE
• MM_API_ERROR_THIRD_PARTY_REQUEST_FAILED
• MM_API_ERROR_UNSUPPORTED_OUTPUT_TYPE
• MM_API_ERROR_UNSUPPORTED_SEARCH_TYPE
• MM_API_ERROR_UNSUPPORTED_SERVICE
• MM_API_UNSUPPORTED_REQUEST_TYPE
• MM_GEOCODE_MULTIPLE_MATCHES
• MM_GEOCODE_NO_MATCHES

error_explanation

String error_explanation

Plain text explanation of an error produced by the last call to search().

record_sets

Array record_sets

The result set found by the last call to search().

MMSearchRequester

MMSearchRequester( <Function> callback )

The Multimap API Searching module - JavaScript library.
JavaScript library for accessing the functionality of the Multimap API Searching module
Requires access to the Multimap API Searching module - please contact your Multimap account manager for further information

Parameters:
callback - Function to call when the search completes.

search

void search( search )

Attempts to perform a search; calls the callback function on completion. The search object exposes two attributes that can be retrieved by the callback function. The first is record_set. The second is error_code which will be undefined if no error occurred, otherwise a valid error code.

Parameters:
MMSearch - object containing the search criteria to use.