Foxit PDF SDK
fsdk.SearchIndexConfig Class Reference

Public Member Functions

def GetIs_available ()
 Get specifies whether the serch index is available for selection and searching. More...
 
def GetIs_selected ()
 Get specifies whether the search index participates in the search. More...
 
def GetName ()
 Get the name of search index. More...
 
def GetPath ()
 Get the path of the search index. More...
 
def Set (name, is_available, path, is_selected)
 Set values. More...
 
def SetIs_available (value)
 Set specifies whether the serch index is available for selection and searching. More...
 
def SetIs_selected (value)
 Set specifies whether the search index participates in the search. More...
 
def SetName (value)
 Set the name of search index. More...
 
def SetPath (value)
 Set the path of the search index. More...
 

Detailed Description

This class represents search index config.

Member Function Documentation

◆ GetIs_available()

fsdk.SearchIndexConfig.GetIs_available ( )

Get specifies whether the serch index is available for selection and searching.

Returns
Specifies whether the serch index is available for selection and searching. true means the index is available, while false means not.

◆ GetIs_selected()

fsdk.SearchIndexConfig.GetIs_selected ( )

Get specifies whether the search index participates in the search.

Returns
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.

◆ GetName()

fsdk.SearchIndexConfig.GetName ( )

Get the name of search index.

Returns
The name of search index.

◆ GetPath()

fsdk.SearchIndexConfig.GetPath ( )

Get the path of the search index.

Returns
The path of the search index.

◆ Set()

def fsdk.SearchIndexConfig.Set (   name,
  is_available,
  path,
  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.

◆ SetIs_available()

fsdk.SearchIndexConfig.SetIs_available (   value)

Set specifies whether the serch index is available for selection and searching.

Parameters
[in]valueSpecifies whether the serch index is available for selection and searching. true means the index is available, while false means not.
Returns
None.

◆ SetIs_selected()

fsdk.SearchIndexConfig.SetIs_selected (   value)

Set specifies whether the search index participates in the search.

Parameters
[in]valueSpecifies 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.
Returns
None.

◆ SetName()

fsdk.SearchIndexConfig.SetName (   value)

Set the name of search index.

Parameters
[in]valueThe name of search index.
Returns
None.

◆ SetPath()

fsdk.SearchIndexConfig.SetPath (   value)

Set the path of the search index.

Parameters
[in]valueThe path of the search index.
Returns
None.