<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"><channel><title>SearchIndexDocument Script API Type</title><link>https://community.telligent.com/community/11/w/api-documentation/66775/searchindexdocument-script-api-type</link><description /><dc:language>en-US</dc:language><generator>14.0.0.586 14</generator><item><title>SearchIndexDocument Script API Type</title><link>https://community.telligent.com/community/11/w/api-documentation/66775/searchindexdocument-script-api-type</link><pubDate>Wed, 20 Nov 2019 15:10:11 GMT</pubDate><guid isPermaLink="false">2c27d06a-5bca-41a0-b287-8b124c177d41</guid><dc:creator>Ben Tiedt</dc:creator><comments>https://community.telligent.com/community/11/w/api-documentation/66775/searchindexdocument-script-api-type#comments</comments><description>Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 15:10:11&lt;br /&gt;
&lt;hr class="generated-documentation-start" style="border-width:0;" /&gt;&lt;div class="documentation"&gt;&lt;ul&gt;&lt;li&gt;&lt;a href="#Properties"&gt;Properties&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#AddField"&gt;AddField&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#HasErrors"&gt;HasErrors&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#HasWarnings"&gt;HasWarnings&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#HasWarningsOrErrors"&gt;HasWarningsOrErrors&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#RemoveField"&gt;RemoveField&lt;/a&gt;&lt;/li&gt;&lt;li&gt;&lt;a href="#ThrowErrors"&gt;ThrowErrors&lt;/a&gt;&lt;/li&gt;&lt;/ul&gt;&lt;a name="Properties"&gt;&lt;/a&gt;&lt;div class="documentation-members properties"&gt;&lt;h3&gt;&lt;a id="Properties" name="Properties"&gt;&lt;/a&gt;Properties&lt;/h3&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Access&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Boost&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Single&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Boost&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Content&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Content&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;ContentId&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Guid&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Content Id&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;ContentTypeId&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;Guid&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Content Type Id&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Errors&lt;/td&gt;&lt;td rowspan="1"&gt;Read&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;IList of [[Error Script API Type|Error]]&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Errors&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Id&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Id&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;IndexFields&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;List of [[IndexField Script API Type|IndexField]]&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Index Fields&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Title&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Title&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;TypeName&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Type Name&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Url&lt;/td&gt;&lt;td rowspan="1"&gt;Read, Write&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Url&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;Warnings&lt;/td&gt;&lt;td rowspan="1"&gt;Read&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;IList of [[Warning Script API Type|Warning]]&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Warnings&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;/div&gt;&lt;div class="documentation-members methods"&gt;&lt;h3&gt;&lt;a id="Methods" name="Methods"&gt;&lt;/a&gt;Methods&lt;/h3&gt;&lt;a name="AddField"&gt;&lt;/a&gt;&lt;h2&gt;&lt;a id="AddField" name="AddField"&gt;&lt;/a&gt;AddField&lt;/h2&gt;&lt;h4&gt;&lt;a id="Velocity" name="Velocity"&gt;&lt;/a&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;$searchIndexDocument.AddField($fieldName, $fieldValue)&lt;/pre&gt;&lt;h4&gt;&lt;a id="JavaScript" name="JavaScript"&gt;&lt;/a&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;searchIndexDocument.AddField(fieldName, fieldValue);&lt;/pre&gt;&lt;h4&gt;&lt;a id="Parameters" name="Parameters"&gt;&lt;/a&gt;&lt;em&gt;Parameters&lt;/em&gt;&lt;/h4&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default&lt;/th&gt;&lt;th&gt;Options&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;fieldName&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Field Name&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;fieldValue&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Field Value&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;h4&gt;&lt;a id="Returns" name="Returns"&gt;&lt;/a&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;span&gt;Nothing&lt;/span&gt;&lt;a name="HasErrors"&gt;&lt;/a&gt;&lt;h2&gt;&lt;a id="HasErrors" name="HasErrors"&gt;&lt;/a&gt;HasErrors&lt;/h2&gt;&lt;h4&gt;&lt;a id="Velocity" name="Velocity"&gt;&lt;/a&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($booleanResponse = $searchIndexDocument.HasErrors())&lt;/pre&gt;&lt;h4&gt;&lt;a id="JavaScript" name="JavaScript"&gt;&lt;/a&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var booleanResponse = searchIndexDocument.HasErrors();&lt;/pre&gt;&lt;h4&gt;&lt;a id="Returns" name="Returns"&gt;&lt;/a&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;Boolean&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;a name="HasWarnings"&gt;&lt;/a&gt;&lt;h2&gt;&lt;a id="HasWarnings" name="HasWarnings"&gt;&lt;/a&gt;HasWarnings&lt;/h2&gt;&lt;h4&gt;&lt;a id="Velocity" name="Velocity"&gt;&lt;/a&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($booleanResponse = $searchIndexDocument.HasWarnings())&lt;/pre&gt;&lt;h4&gt;&lt;a id="JavaScript" name="JavaScript"&gt;&lt;/a&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var booleanResponse = searchIndexDocument.HasWarnings();&lt;/pre&gt;&lt;h4&gt;&lt;a id="Returns" name="Returns"&gt;&lt;/a&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;Boolean&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;a name="HasWarningsOrErrors"&gt;&lt;/a&gt;&lt;h2&gt;&lt;a id="HasWarningsOrErrors" name="HasWarningsOrErrors"&gt;&lt;/a&gt;HasWarningsOrErrors&lt;/h2&gt;&lt;h4&gt;&lt;a id="Velocity" name="Velocity"&gt;&lt;/a&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;#set($booleanResponse = $searchIndexDocument.HasWarningsOrErrors())&lt;/pre&gt;&lt;h4&gt;&lt;a id="JavaScript" name="JavaScript"&gt;&lt;/a&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;var booleanResponse = searchIndexDocument.HasWarningsOrErrors();&lt;/pre&gt;&lt;h4&gt;&lt;a id="Returns" name="Returns"&gt;&lt;/a&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;p&gt;&lt;div&gt;&lt;code&gt;Boolean&lt;/code&gt;&lt;/div&gt;&lt;/p&gt;&lt;a name="RemoveField"&gt;&lt;/a&gt;&lt;h2&gt;&lt;a id="RemoveField" name="RemoveField"&gt;&lt;/a&gt;RemoveField&lt;/h2&gt;&lt;h4&gt;&lt;a id="Velocity" name="Velocity"&gt;&lt;/a&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;$searchIndexDocument.RemoveField($field)&lt;/pre&gt;&lt;h4&gt;&lt;a id="JavaScript" name="JavaScript"&gt;&lt;/a&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;searchIndexDocument.RemoveField(field);&lt;/pre&gt;&lt;h4&gt;&lt;a id="Parameters" name="Parameters"&gt;&lt;/a&gt;&lt;em&gt;Parameters&lt;/em&gt;&lt;/h4&gt;&lt;table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"&gt;&lt;thead&gt;&lt;tr class="WikiTableBgBlue"&gt;&lt;th&gt;Name&lt;/th&gt;&lt;th&gt;Type&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;Required&lt;/th&gt;&lt;th&gt;Default&lt;/th&gt;&lt;th&gt;Options&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;&lt;tbody&gt;&lt;tr&gt;&lt;td rowspan="1"&gt;field&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;code&gt;[[IndexField Script API Type|IndexField]]&lt;/code&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;Field&lt;/td&gt;&lt;td rowspan="1"&gt;Required&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;td rowspan="1"&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/tbody&gt;&lt;/table&gt;&lt;h4&gt;&lt;a id="Returns" name="Returns"&gt;&lt;/a&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;span&gt;Nothing&lt;/span&gt;&lt;a name="ThrowErrors"&gt;&lt;/a&gt;&lt;h2&gt;&lt;a id="ThrowErrors" name="ThrowErrors"&gt;&lt;/a&gt;ThrowErrors&lt;/h2&gt;&lt;h4&gt;&lt;a id="Velocity" name="Velocity"&gt;&lt;/a&gt;&lt;em&gt;Velocity&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: velocity"&gt;$searchIndexDocument.ThrowErrors()&lt;/pre&gt;&lt;h4&gt;&lt;a id="JavaScript" name="JavaScript"&gt;&lt;/a&gt;&lt;em&gt;JavaScript&lt;/em&gt;&lt;/h4&gt;&lt;pre class="brush: javascript"&gt;searchIndexDocument.ThrowErrors();&lt;/pre&gt;&lt;h4&gt;&lt;a id="Returns" name="Returns"&gt;&lt;/a&gt;&lt;em&gt;Returns&lt;/em&gt;&lt;/h4&gt;&lt;span&gt;Nothing&lt;/span&gt;&lt;/div&gt;&lt;/div&gt;&lt;hr class="generated-documentation-end" style="border-width:0;" /&gt;&lt;div style="clear:both;"&gt;&lt;/div&gt;
</description></item></channel></rss>