IndexingSearchServices.Search Method

IndexingSearchServicesSearch Method

Ingeniux CMS Web Services API

Search in pages that match any of the given keywords, with given field name and schema name criterias

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<SearchResultModel> Search(
	string keywords,
	string fieldName,
	string schemaName,
	bool fieldIsAttribute,
	bool useCheckedOutContent,
	bool includeVersions,
	bool includeRecyled
)

Public Function Search ( 
	keywords As String,
	fieldName As String,
	schemaName As String,
	fieldIsAttribute As Boolean,
	useCheckedOutContent As Boolean,
	includeVersions As Boolean,
	includeRecyled As Boolean
) As XHRServiceResponseGeneric(Of SearchResultModel)

public:
virtual XHRServiceResponseGeneric<SearchResultModel^>^ Search(
	String^ keywords, 
	String^ fieldName, 
	String^ schemaName, 
	bool fieldIsAttribute, 
	bool useCheckedOutContent, 
	bool includeVersions, 
	bool includeRecyled
) sealed

abstract Search : 
        keywords : string * 
        fieldName : string * 
        schemaName : string * 
        fieldIsAttribute : bool * 
        useCheckedOutContent : bool * 
        includeVersions : bool * 
        includeRecyled : bool -> XHRServiceResponseGeneric<SearchResultModel> 
override Search : 
        keywords : string * 
        fieldName : string * 
        schemaName : string * 
        fieldIsAttribute : bool * 
        useCheckedOutContent : bool * 
        includeVersions : bool * 
        includeRecyled : bool -> XHRServiceResponseGeneric<SearchResultModel>

Parameters

keywords: Type: SystemString
The keywords to search for. Please note that pages with matches of any of the keywords will be returned
fieldName: Type: SystemString
Narrow down which field to search for on the page
Remarks

When left empty, search in all page fields
schemaName: Type: SystemString
Narrow down on the schema Root name that page was based on. Only pages with given root name will be search.
Remarks

When left empty, search all pages
fieldIsAttribute: Type: SystemBoolean
Specifies the given field is an element or attribute. Only applies when fieldName is specified.
useCheckedOutContent: Type: SystemBoolean
Specifies whether to include page check out content in search. Page check out content will be separate entries.
includeVersions: Type: SystemBoolean
Specifies whether to include previous version of the pages in search.
includeRecyled: Type: SystemBoolean
Specifies whether to allow pages in recycle folder to be included in search.

Return Value

Type: XHRServiceResponseGenericSearchResultModel

Collection of page summaries that matches the given criterias.

Examples

Sample JSON return

JavaScript

Copy

 {
    "code": 0,
    "error": null,
    "message": {
        "MaxScore": 5,
        "Results": [{
            "AssignedUserOrGroup": "U|INGENIUX\\awang",
            "CheckedOut": true,
            "ID": "x100",
            "LastModifiedTime": "20140120T18:44:57",
            "Name": "Default Dynamic Schemas Test",
            "PageID": "x100",
            "Rank": 4,
            "Recycled": false,
            "Version": 0
        }, {
            "AssignedUserOrGroup": "U|INGENIUX\\awang",
            "CheckedOut": true,
            "ID": "x87",
            "LastModifiedTime": "20140121T22:50:04",
            "Name": "Test",
            "PageID": "x87",
            "Rank": 4,
            "Recycled": false,
            "Version": 0
        }]
    }
}

Reference

IndexingSearchServices Class

IngeniuxCMService Namespace