Foxit PDF SDK
FSSearchIndexConfig Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithSearch_index_config:
 Constructor, with another search index config object.
More...
 
(void) - set:is_available:path:is_selected:
 Set values.
More...
 

Properties

BOOL is_available
 Specifies whether the serch index is available for selection and searching. YES means the index is available, while NO means not.

 
BOOL is_selected
 Specifies whether the search index participates in the search. YES means the index is searched as part of the query, while NO means it is not searched.

 
NSString * name
 The name of search index.

 
NSString * path
 The path of the search index.

 

Detailed Description

This class represents search index config.

Method Documentation

◆ initWithSearch_index_config:()

- (id) initWithSearch_index_config: (FSSearchIndexConfig*)  search_index_config

Constructor, with another search index config object.

Parameters
[in]search_index_configAnother search index config object.

◆ set:is_available:path:is_selected:()

- (void) set: (NSString *)  name
is_available: (BOOL)  is_available
path: (NSString *)  path
is_selected: (BOOL)  is_selected 

Set values.

Parameters
[in]nameThe name of search index.
[in]is_availableSpecifies whether the serch index is available for selection and searching.
[in]pathThe path of the search index.
[in]is_selectedSpecifies whether the search index participates in the search.
Returns
None.