SPSearch Class
Properties Methods Events Configuration Settings Errors
Provides search capabilities to a SharePoint site.
Syntax
insp.spsearch()
Remarks
The SPSearch class allows you to search SharePoint sites.
To get started, set the URL, User, and Password properties to point the class to your Site.
To retrieve the status for the search service on the SharePoint site, call the GetStatus method.
To use the search service, set the SearchType property to the type of query to use in the search. Next, call the Search method with a valid Query parameter. Once the method returns, the ResultCount and ResultIndex properties can be used to iterate through each search result. The ResultProperties collection can be used to get information about each of the results returned by SharePoint.
About SharePoint Online Services
When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AuthScheme | The authentication scheme to be used while authenticating with the server. |
| EnableStemming | Enables stemming in the search. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| Idle | The current status of the component. |
| IgnoreNoise | Whether or not to ignore noise words in the search. |
| Password | The password to use for authentication. |
| PropertyCount | The number of records in the Property arrays. |
| PropertyName | The name of the property. |
| PropertySortBy | Set this value to Ascending or Descending to tell SharePoint that this property will be used to sort the results that will be returned. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| RangeCount | The number of results to return in the search. |
| RangeStart | The starting index of the results. |
| ResultCount | The number of results. |
| ResultIndex | The result index. |
| ResultPropertyCount | The number of records in the ResultProperty arrays. |
| ResultPropertyName | The name of the parameter. |
| ResultPropertyValue | The value of the parameter. |
| SearchType | The type of query used in the search. |
| SharePointVersion | The SharePoint version. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| Timeout | A timeout for the component. |
| TotalResults | Gets the total number of results. This property is populated after calling to Search . |
| TrimDuplicates | Remove duplicate results. |
| URL | The base URL for the site. |
| User | The user account to use for authentication. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| GetResultProperty | Retrieves the value of a property of a result. |
| GetStatus | Get the status of the search service. |
| Interrupt | Interrupt the current method. |
| Reset | Resets request-related properties. |
| Search | Searches the specified SharePoint site. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| CapitalizeFirstLetters | Whether or not to capitalize the first letter. |
| EnableSpellCheck | Enables spell checking. |
| HighlightQuerySuggestions | Whether or not to highlight query suggestions. |
| IncludeHighConfidenceResults | Includes high-confidence results. |
| IncludeImplicitAND | Whether to include a default AND between search terms. |
| IncludePreQuerySuggestions | Includes pre-query suggestions. |
| IncludeRelevantResults | Includes relevant results. |
| IncludeSpecialTermResults | Includes special term results. |
| ResubmitFlags | Specifies how to handle resubmissions. |
| ResultProvider | The result provider to use. |
| ResultType | The result type of the current search result. |
| ElapsedTime | The total time (in milliseconds) used for the search. |
| IsTotalResultsExact | Determines if the TotalResults is exact. |
| FormBasedCookies | Holds the security cookies for Form-Based Authentication. |
| SPOnlineSecurityCookies | Holds the security cookies for SharePoint Online. |
| SPOnlineSSO | Whether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS). |
| SPOnlineSTS | The URL of the online STS. |
| SPOnlineADFSAuthScheme | The HTTP authentication scheme used when working with SSO. |
| SSODomain | Specifies the federation domain configured in Office 365. |
| CodePage | The system code page used for Unicode to Multibyte translations. |