SearchIndexConfig Class Reference

Inheritance diagram for SearchIndexConfig:

Public Member Functions
	constructor ()
	Constructor.
	constructor (name, is_available, path, is_selected)
	Constructor, with parameters. More...
	constructor (r)
	Set (name, is_available, path, is_selected)
	Set values. More...
Public Member Functions inherited from NativeObjectWrapper
	constructor (r)
	GetPointerAsNumber ()

Public Attributes
	is_available
	Specifies whether the serch index is available for selection and searching. true means the index is available, while false means not.
	is_selected
	Specifies whether the search index participates in the search. true means the index is searched as part of the query, while false means it is not searched.
	name
	The name of search index.
	path
	The path of the search index.

Detailed Description

This class represents search index config.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

constructor() [1/2]

SearchIndexConfig.constructor	(	name	,
		is_available	,
		path	,
		is_selected
	)

Constructor, with parameters.

Parameters

[in]	name	The name of search index.
[in]	is_available	Specifies whether the serch index is available for selection and searching.
[in]	path	The path of the search index.
[in]	is_selected	Specifies whether the search index participates in the search.

constructor() [2/2]

SearchIndexConfig.constructor

(

r

)

@constructor

Parameters

{NativeObjectReference}

r - The native object reference to wrap

@description Creates a new wrapper instance around a native C++ object. The wrapper manages the object's lifecycle according to the ownership rules.

Set()

SearchIndexConfig.Set	(	name	,
		is_available	,
		path	,
		is_selected
	)

Set values.

Parameters

[in]	name	The name of search index.
[in]	is_available	Specifies whether the serch index is available for selection and searching.
[in]	path	The path of the search index.
[in]	is_selected	Specifies whether the search index participates in the search.

Returns

None.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.